TamilKavi Website

The official website and online interface for the TamilKavi project.

Table of Contents

• About Project
• Demo
• Technologies Used
• Installation (for local development)
• Features
• Contribution
• License
• Contact Us
• Acknowledge

About Project

The Tamil Kavi Website (tamilkavi.jigg.win) serves as the online presence for the TamilKavi project. It provides a user-friendly interface to explore the collection of Tamil poetry, learn about the associated Python package and dataset, and offers a convenient way for contributors to submit new poems to the collection via a dedicated submission form.

This website complements the TamilKavi Python Package by offering a browser-based experience.

Demo

Experience the Tamil Kavi Website live at:

https://tamilkavi.jigg.win/

Technologies Used

This website is built using the following technologies:

• Frontend: React
• Language: TypeScript
• Styling: Tailwind CSS
• Icons: Lucide React
• Package Manager: npm, Yarn, or pnpm

Installation (for local development)

To set up and run the website locally for development or testing:

1. Clone the repository: bash git clone https://github.com/anandsundaramoorthysa/tamilkaviwebsite.git cd tamilkaviwebsite
2. Install dependencies: Make sure you have Node.js and npm/yarn/pnpm installed. Then run: bash npm install # or yarn install or pnpm install
3. Run the development server: bash npm start # or yarn start or pnpm start This will start the development server, and the website should be accessible in your browser, usually at http://localhost:8080.

Features

• Online browsing and exploration of the Tamil poetry collection.
• Filtering and searching capabilities for poems, authors, and books.
• Information about the TamilKavi Python package and dataset.
• A dedicated submission form for contributing new poems to the collection.
• Responsive design for various devices.
• Links to the project's GitHub repository, Hugging Face Dataset and PyPI page.

Contribution

We welcome contributions to the Tamil Kavi Website project! You can contribute in two main ways: by helping improve the website code or by contributing poetry data.

Contributing to the Website Code

If you'd like to contribute to the development of the website itself (fixing bugs, adding features, improving UI/UX):

1. Fork the repository: Fork the Website GitHub repository to your own account.
2. Clone your fork: Clone your forked repository to your local machine.
3. Create a new branch: Create a branch for your contribution (e.g., feat/new-feature or fix/bug-fix).
4. Make your changes: Write code following the existing structure and style (React, TypeScript, Tailwind CSS).
5. Test locally: Ensure your changes work correctly by running the site locally (npm start).
6. Commit and Push: Commit your changes with clear messages and push them to your fork.
7. Submit a Pull Request: Open a pull request from your fork's branch to the main repository's main branch. Describe your changes clearly.

Contributing Poetry Data

The easiest way to contribute new Tamil poems to the collection is by using the dedicated submission form on the website.

Go to Submission Form

Alternatively, if you are comfortable with GitHub and contributing directly to the data source, please refer to the contribution guidelines in the TamilKavi Python Package repository.

License

This project is licensed under the MIT License - see the LICENSE file in this repository for details.

Contact Us

If you have any questions, feedback, or suggestions regarding the website or the project, feel free to reach out to the authors:

• ANAND SUNDARAMOORTHY SA: sanand03072005@gmail.com

Acknowledge

We want to express our gratitude to:

• Praveen Kumar Purushothaman (@praveenscience) for providing the subdomain tamilkavi.jigg.win for the website.
• Selvakumar Duraipandian – Sponsor (Domain Supporter) 🙏 Thanks to him for sponsoring the tamilkavi.com domain for us.
• The association with the TamilKavi Python Package.