Skip to content

Latest commit

 

History

History
107 lines (70 loc) · 3.57 KB

CONTRIBUTING.md

File metadata and controls

107 lines (70 loc) · 3.57 KB
Raw

Getting Started

  1. Clone the repository:

    git clone https://github.com/Akash-Singh04/EduSync.git

  2. Install dependencies:

    cd EduSync
npm install

  3. Firebase Configuration Setup

  • Contact @Akash-Singh04 to get the .env file containing the firebase configurations. After getting the env file skip to step (d).
  • Alternatively Contact @Akash-Singh04 to get collaborator access to the firebase project that contains the User Authentication and Firebase Firestore Database. An email will be sent with the invitaion for the same.
  1. Steps to Set Firebase Environment Variables

a. After Getting Collaborator Access:

  • Visit the Firebase Console
  • Navigate to the project settings.

b. Retrieve Firebase Configuration:

  • In the Firebase project settings, locate and select the "General" tab.
  • Scroll down to the "Your apps" section and click on EduSync c. Copy Configuration Details:
  • After creating the web app, you'll get a configuration object containing keys like apiKey, authDomain, projectId, etc.
  • Copy these configuration details.

d. Environment Variable Setup:

  • Create a .env.local file in the root directory of your project (ensure it's added to .gitignore for security).
  • Add the Firebase configuration details as environment variables:
NEXT_PUBLIC_FIREBASE_API_KEY="YOUR_FIREBASE_API_KEY"
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN="YOUR_FIREBASE_AUTH_DOMAIN"
NEXT_PUBLIC_FIREBASE_PROJECT_ID="YOUR_FIREBASE_PROJECT_ID"
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET="YOUR_FIREBASE_STORAGE_BUCKET"
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID="YOUR_FIREBASE_MESSAGING_SENDER_ID"
NEXT_PUBLIC_FIREBASE_APP_ID="YOUR_FIREBASE_APP_ID"
NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID="YOUR_FIREBASE_MEASUREMENT_ID"  // (Optional, for Analytics)

e. Usage in Project:

  • Access these environment variables in your code as process.env.VARIABLE_NAME.

f. Restart Server:

  • After setting environment variables, restart the development server to apply the changes.
Note:
  • Ensure that you replace "YOUR_FIREBASE_XXX" placeholders with the actual values from your Firebase project configuration.
  • Remember to keep your .env.local file private and do not expose sensitive credentials in your code repository.

  1. Run the project:

    npm run dev

  2. Access the project locally at http://localhost:3000.

  3. Run the Flask Backend Server:

a. Navigate to the Flask App Directory:

  • Use the cd command to move into the directory of your cloned Flask app: 
    cd Flask

b. Install Required Dependencies:

  • Use pip to install the necessary dependencies from the requirements.txt file: 
    pip install -r requirements.txt

c. Run the Flask Server:

  • Start the Flask server by running the following command: 
    flask run

d. Access the Flask App:

  • Once the server starts, open a web browser and navigate to http://127.0.0.1:5000/ or http://localhost:5000/ to see your Flask app running locally.

Check the Falcon Documentation for the guide to run the Falcon 7B model

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!

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