CONTRIBUTING.md

Contributing to Motion-Amplification-Video

Thank you for your interest in contributing to Motion-Amplification-Video! We appreciate your help in making this project better.

Development Setup

Frontend (React)

1. Clone the Repository:

   git clone https://github.com/Akash-Singh04/Motion-Amplification-Video
   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 server

2. Install Dependencies:

   npm install

3. Run the Server:

   npm start

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

Flask Backend

1. Install Flask Dependencies:

   pip install -r requirements.txt

2. Run the Flask Server:

   flask run main.py

   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.

Storage (AWS S3)

• AWS S3 is used as the storage bucket for the application. Configure AWS credentials and update the backend accordingly for S3 integration.

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!