This project is a frontend application built using React, TypeScript, Vite, Tailwind CSS, and Material UI.
Before starting, make sure you have the following tools installed:
-
Clone the repository:
git clone cd frontend Install dependencies:
npm install Running the Project To start the project in development mode, use the following command:
npm run dev This command will launch a Vite development server, and you can view the application at http://localhost:5173 (or another specified port).
Building the Project To create a production build, run:
npm run build The compiled files will be available in the dist folder.
Linting To check the code for errors and stylistic issues, use the following command:
npm run lint Technology Stack React: Library for building user interfaces TypeScript: Superset of JavaScript for safer development Vite: Build tool and development server Tailwind CSS: Utility-first CSS framework Material UI: React UI components Redux Toolkit: For state management How to Contribute Create a new branch for your changes:
git checkout -b your_branch_name Make your changes and commit them:
git commit -m "Your commit message" Push your changes to the remote repository:
git push origin your_branch_name Open a Pull Request on GitHub.
Getting Started with Development Here are the key steps for working on the project:
Fork the Repository: If you are an external contributor, fork the repository to your GitHub account.
Set Up Environment Variables: If required, create a .env file and add necessary configurations.
Run Tests: Before submitting changes, run the tests (if configured):
npm run test Pull Updates: Keep your local repository up to date with the main branch:
git pull origin main Additional Resources Vite Documentation React Documentation Material UI Documentation Tailwind CSS Documentation Redux Toolkit Documentation Feel free to raise issues or contribute by submitting pull requests!