Skip to content

Latest commit

 

History

History
115 lines (69 loc) · 3.62 KB

BACKEND.md

File metadata and controls

115 lines (69 loc) · 3.62 KB
Raw

Contributing to Backend ✨🚀

Welcome to the Animating Buttons project! If you're interested in contributing to the backend of this project, you're in the right place. This guide will walk you through the process of setting up the backend environment and making contributions.

Getting Started 💻

To get started with contributing to the frontend, follow these steps:

First Steps-

  1. Create issue in the Animating Buttons repository.
  2. Once you are assigned the issue, move ahead with the following procedure-

Fork, Clone, Navigate the Repository-

  1. Fork the Repository : Start by forking the Animating Buttons repository to your own GitHub account. (Click the Fork button in the top right corner of the page).

  2. Clone the Repository : Clone the forked repository to your local machine using the following command:

  git clone https://github.com/**username**/Animating-Buttons.git
  1. Navigate to project Directory : Move to the project directory using:
cd Animating-Buttons
  1. Install Dependencies : Install the necessary dependencies using npm:
npm i
npm start
  1. Create .env File : Create a .env file in the root directory of the project and populate it with the variables given in the environment variables section.

Environment Variables 👨‍💻

To run this project, you will need to add the following environment variables to your .env file

REACT_APP_apiKey

REACT_APP_authDomain

REACT_APP_projectId

REACT_APP_storageBucket

REACT_APP_messagingSenderId

REACT_APP_appId

REACT_APP_measurementId

Making Contributions 🤝

Now that you have the environment set up, you can start making contributions:

  1. Navigate to Backend Directory : Move to the backend directory of the project using:
cd Animating-Buttons
  1. Create a New Branch : Create a new branch for your feature or bug fix using a descriptive name:
  git checkout -b my-new-branch

  1. Optimize and Refactor : As the project backend utilizes Firebase, consider optimizing requests and improving the code structure. Explore the codebase to identify areas for improvement.

  2. Server Folder : If you're adding new files or refactoring code, consider placing them in the server folder for better organization.

  3. Add to Staging Area : Add the changes you made to the staging area of git by using:

# To check the state of the working directory and the staging area
git status

# To add all new files to branch my-new-branch
git add .

# To add only a few files to my-new-branch
git add <some files>
  1. Commit Changes : Commit your changes with a meaningful commit message:
git commit -m "Add description of your changes"
  1. Push Changes : Push your changes to your forked repository:
git push -u origin my-new-branch

  1. Create Pull Request :

    • Go to your repository in browser and click on compare and pull requests.
    • Then add a title and description to your pull request that explains your contribution.

  2. To know more about how to contribute, read the Countributing Guidelines

Contact 📱

If you have any questions or need assistance, feel free to reach out to the project maintainers or contributors through GitHub's communication channels.

Thank you for your interest in contributing to Animating Buttons!