Skip to content

Latest commit

 

History

History
88 lines (63 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

88 lines (63 loc) · 2.18 KB
Raw

Contributing to ClassSnap

Thank you for your interest in contributing to ClassSnap! We appreciate your help in making this project better.

Development Setup

Frontend (React)

  1. Clone the Repository:

    git clone https://github.com/Akash-Singh04/ClassSnap
cd frontend

  2. Install Dependencies:

    npm install

  3. Run the Development Server:

    npm start

    The development server will start at http://localhost:3000.

Backend (Express Node + Flask)

Express Node Backend

  1. Navigate to Backend Directory:

    cd backend

  2. Install Dependencies:

    npm install

  3. Run the Server:

    npm start

    The Express Node backend will run at http://localhost:4000.

Flask Backend

  1. Navigate to Flask Backend Directory:

    cd NotesGeneration

  2. Set Up Virtual Environment (Optional but Recommended):

    python -m venv venv
source venv/bin/activate  # For macOS/Linux. Use venv\Scripts\activate for Windows.

  3. Install Flask Dependencies:

    pip install -r requirements.txt

  4. Run the Flask Server:

    flask run

    The Flask backend will run at http://localhost:5000.

Database (MongoDB Atlas)

  • MongoDB Atlas is used as the database. Ensure the connection string is correctly configured in the backend environments.

Contributing Guidelines

  • Fork the repository, make changes, and submit a pull request.
  • Ensure code quality, follow coding standards, and write descriptive commit messages.
  • Create an issue to discuss significant changes or enhancements before implementation.
  • Write tests for new features and bug fixes if applicable.

Please view the list of open issues at Issues. Any contributions to them are welcome.

Questions or Need Help?

If you have any questions or need further assistance, feel free to open an issue or reach out to Akash-Singh04.

We appreciate your contributions and look forward to your involvement in improving Motion-Amplification-Video!