---

Project Name

Description (to be updated)

Table of Contents

• Project Setup
  • Backend
  • Frontend
• Technologies Used
• How to Contribute
• Commit Message Format
• Pull Request Guidelines
• License

Project Setup

Backend Setup

Requirements

• Python 3.x
• Virtual environment (venv) or other preferred environment manager

Installation

1. Clone the repository:

   git clone https://github.com/ritwik-69/Astrocoders-Project.git
   cd Astrocoders-Project/backend

2. Create a virtual environment named venv and activate it:

   • Windows:

     python -m venv venv
     .\venv\Scripts\activate

   • Linux/macOS:

     python -m venv venv
     source venv/bin/activate

3. Install dependencies:

   pip install -r requirements.txt

4. Run the application:

   python main.py  # or the entry point for your application

Frontend Setup

Requirements

• Node.js (version 14.x or higher)
• npm or yarn

Installation

1. Navigate to the frontend directory:

   cd Astrocoders-Project/frontend

2. Install dependencies:

   npm install  # or yarn install

3. Start the development server:

   npm run dev  # or yarn dev

4. Open your browser and visit http://localhost:5173 (Vite's default port).

Tailwind CSS Configuration

The project uses Tailwind CSS for styling. Tailwind is already integrated with the Vite and React setup. You can add or modify styles by updating the tailwind.config.js file and using the utility classes in your components.

Technologies Used

Backend:

• Python 3.x
• Flask
• PostgreSQL / MySQL (or any other database)
• Firebase (to be confirmed)

Frontend:

• React
• Vite
• Tailwind CSS for styling

How to Contribute

1. Fork the repository.
2. Create your feature branch (git checkout -b feature/your-feature-name).
3. Commit your changes following the commit message format.
4. Push to your branch (git push origin feature/your-feature-name).
5. Open a pull request.

Commit Message Format

Please follow the conventional commits format for commit messages to keep history clean and consistent.

<type>(<scope>): <subject>

Types:

• feat: A new feature
• fix: A bug fix
• docs: Documentation changes
• style: Code style changes (white-space, formatting, etc.)
• refactor: Code changes that neither fix bugs nor add features
• test: Adding or updating tests
• chore: Other changes like updating dependencies

Example:

feat(auth): add JWT authentication
fix(user-profile): resolve crash on profile update
docs(readme): update installation steps

Pull Request Guidelines

1. Ensure the code is well formatted and adheres to the project's coding style.
2. Reference the related issue or task in the PR description (e.g., Closes #42).
3. Provide a brief description of what was changed and why.
4. Ensure your code includes tests, if applicable.
5. Link any relevant screenshots or evidence of changes, if visual.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

---