Firebase Setup for Your Project

This guide provides the steps to configure Firebase in your project, enabling Firebase Authentication, Firestore, and other Firebase services as needed.

Steps for Firebase Setup

1. Create dbconfig Folder

• Navigate to the src directory of your project.
• Create a new folder named dbconfig.

This folder will store your Firebase configuration and any related settings.

2. Create firebase.js File

• Inside the dbconfig folder, create a file named firebase.js.
• Add the following code to firebase.js:

const firebaseConfig = {
  apiKey: "",           // Add your Firebase API key here
  authDomain: "",        // Add your Firebase auth domain here
  projectId: "",         // Add your Firebase project ID here
  storageBucket: "",     // Add your Firebase storage bucket here
  messagingSenderId: "", // Add your Firebase messaging sender ID here
  appId: ""              // Add your Firebase app ID here
};

export default firebaseConfig;

• Note: To find these credentials, go to the Firebase Console, select your project, and navigate to Project Settings.

3. Enable Firebase Services

1. Enable Firebase Authentication

   • Go to the Firebase Console and select your project.
   • In the left-hand menu, under Build, click Authentication.
   • Click Get Started to enable authentication for your project.
   • Set up your preferred authentication methods (e.g., email/password, Google, etc.).

2. Enable Firestore or Realtime Database

   • In the Firebase Console, under Build, you will see options for Firestore Database or Realtime Database.
   • Choose one based on your application's needs:
   • Firestore Database: A scalable NoSQL cloud database for structured data.
   • Realtime Database: A cloud-hosted NoSQL database that stores data in JSON format and synchronizes in real-time.
   • Click Create Database and follow the on-screen instructions to configure database rules and permissions.

3. Conclusion

   • Your Firebase configuration is now set up. You can integrate Firebase services into your project, initialize the Firebase app, and use services like authentication and database operations.

4. Install Firebase SDK

• Make sure to install Firebase in your project by running the following command:

npm install firebase

Contributing

We appreciate your interest in contributing to zangetsu. Here's how you can get started:

0. Find Issues or Create your Own We appreciate you solving existing issues in the repository in the issues tab or to create new

1. Fork the Repository: Click the "Fork" button at the top of this repository to create a copy in your GitHub account.

2. Clone Your Fork: Clone your fork to your local machine with git clone.

    git clone https://github.com/<your_github_username>/zangetsu.git

3. Change the working directory:

cd zangetsu

4. Add an upstream link to the main branch in your cloned repo:

    git remote add upstream https://github.com/<your_github_username>/zangetsu.git

5. Keep your cloned repo up to date by pulling from upstream (this will also avoid any merge conflicts while committing new changes):

    git pull upstream main

6. Create a New Branch: Make a new branch for your work with a descriptive name.

    git checkout -b <branch-name>

7. Make Changes: Implement your desired feature or fix a bug.

8. Track and stage your changes:

    git status

9. Add all the required changes:

    git add .

10. Commit all the changes (Write commit message as "Small Message"):

    git commit -m "<your-commit-message>"

11. Push the changes for review:

    git push origin <branch-name>

12. Open a Pull Request: Create a pull request from your fork to this repository. Provide a concise title and description.

We'll review your contribution and collaborate to merge it into the project. Please adhere to our code of conduct and guidelines.

If you have questions or need assistance, feel free to open an issue.