README.md

HarmonyCode

Music for your coding 🎵

This is a Next.js project bootstrapped with create-next-app.

Table of Contents

• Getting Started
  • Prerequisites
  • Setting Up Firebase Environment Variables
• Usage
• Contributing
• License
• Gitpod

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js: Make sure you have Node.js installed on your machine. You can download it from nodejs.org.

Setting Up Firebase Environment Variables and Enabling Authentication

To run this project, you need to set up environment variables for Firebase. These variables contain sensitive information and should not be hard-coded in your codebase. Follow these steps to set up the required environment variables:

1. Create a Firebase Project:

   • If you haven't already, create a Firebase project on the Firebase Console.

2. Obtain Firebase Configuration:

   • In the Firebase Console, select your project.

   • Go to Project settings (gear icon) > General.

   • Under the "Your apps" section, select the web app you are using for this project.

   • You will find the Firebase configuration object, which includes the following properties:

     • apiKey
     • authDomain
     • projectId
     • storageBucket
     • messagingSenderId
     • appId

3. Set Up Environment Variables:

   • In your project directory, create a .env.local file (if it doesn't already exist).

   • Add the following lines to the .env.local file:

     NEXT_PUBLIC_API_KEY=<Your-API-Key>
     NEXT_PUBLIC_AUTH_DOMAIN=<Your-Auth-Domain>
     NEXT_PUBLIC_PROJECT_ID=<Your-Project-ID>
     NEXT_PUBLIC_STORAGE_BUCKET=<Your-Storage-Bucket>
     NEXT_PUBLIC_MESSAGING_SENDER_ID=<Your-Messaging-Sender-ID>
     NEXT_PUBLIC_APP_ID=<Your-App-ID>
     NEXT_PUBLIC_GEMINI_API_KEY=<your-gemini-api>

   Replace <Your-API-Key>, <Your-Auth-Domain>, etc., with the respective values you obtained from Firebase.

   • Save the .env.local file.

4. Load Environment Variables:

   • Ensure that you have a method to load environment variables in your Next.js application. You can use packages like dotenv or Vercel's built-in support for environment variables.

5. Enabling Authentication:

   Google Authentication:

   1. Go to the Firebase Console and select your project.
   2. Navigate to the "Authentication" section and click on the "Sign-in method" tab.
   3. Click on "Add new provider", then find "Google" and enable it. Configure OAuth consent screen details if required.
   4. Google Authentication is now enabled in your project.

   For detailed instructions, refer to the Firebase's Google Authentication documentation.

   Github Authentication:

   1. Go to the GitHub Developer Settings and create a new GitHub OAuth application.
   2. Set the "Application Name", "Homepage URL" and ensure the "Authorization callback URL" matches your Firebase project's settings. Register the application.
   3. Note the "Client ID" and "Client Secret."
   4. In the Firebase Console, on your project, navigate to the "Authentication" section.
   5. Enable GitHub Authentication in the "Sign-in method" tab by providing the "Client ID" and "Client Secret" obtained from GitHub. Configure OAuth consent screen details if required.
   6. Github Authentication is now enabled in your project.

   For detailed instructions, refer to the Firebase's GitHub Authentication documentation.

6. Start Your Application:

   • You can now start your Next.js application. The Firebase configuration will be loaded from the environment variables you set up.

Usage

Provide information on how to use your project once the environment variables are set up correctly.

Contributing

We welcome contributions from the community! If you're interested in contributing to this project, please read our contribution guidelines.

License

This project is licensed under the [License Name] - see the LICENSE.md file for details. and contributions are welcome!

---

Best Contributors

Gitpod

Welcome to Gitpod, your cloud-ready development environment where you can start coding directly and see your changes in action on a live server, all without the need to clone the repository. Here's a guide to help you set up and run your app using Gitpod, specifically addressing the need for Firebase environment variables.

Setting Up Environment Variables in Gitpod for Firebase

Before running the app, it's essential to set up Firebase environment variables to ensure the proper functioning of your application. For more detailed information about setting up environment variables in Gitpod, refer to the official Gitpod documentation on Configuring Projects - Environment Variables.

1. Access Gitpod Projects: Navigate to Gitpod Projects and ensure you are logged into your GitHub account.

2. Create a New Gitpod Project: Click on "New Project" and search for the HarmonyCode repository (fork it if necessary). Choose the HarmonyCode repository.

3. Access Project Settings: Once the project is created, go to project settings.

4. Configure Environment Variables: Navigate to the "Variables" section in project settings.

5. Set Firebase Environment Variables: Add the following Firebase configuration variables:

      NEXT_PUBLIC_API_KEY=<Your-API-Key>
      NEXT_PUBLIC_AUTH_DOMAIN=<Your-Auth-Domain>
      NEXT_PUBLIC_PROJECT_ID=<Your-Project-ID>
      NEXT_PUBLIC_STORAGE_BUCKET=<Your-Storage-Bucket>
      NEXT_PUBLIC_MESSAGING_SENDER_ID=<Your-Messaging-Sender-ID>
      NEXT_PUBLIC_APP_ID=<Your-App-ID>

• Replace <Your-API-Key>, <Your-Auth-Domain>, etc., with the respective Firebase configuration values. Refer to the "Setting Up Firebase Environment Variables" section for details.

6. Create a Workspace from the Main Branch: Hover over the "main" branch and click on "Create a new workspace".Click "Continue" to set up the workspace.

7. Verify Environment Variables: Open the terminal in Gitpod and type gp env to verify if the environment variables are correctly set.

8. Start the Application: Start your application by running the command npm run dev.

If you liked this project support it by starring it 🌟 and share it on social media