Skip to content

Latest commit

 

History

History
96 lines (62 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

96 lines (62 loc) · 2.53 KB

How can you Contribute to this Project?

1. Fork the Repository

To contribute to the project, you need to fork the repository to your GitHub account. You can do this by clicking on the Fork button at the top right corner of the repository page.

2. Clone the Repository

git clone https://github.com/yashksaini-coder/leetcode-journal

# Navigate to the project directory
cd leetcode-journal

3. Install Dependencies

npm install

4. Set Up Supabase

  • Go to the Supabase website and create an account.
  • Create a new project in Supabase.
  • Navigate to the API section and create a new API key.
  • Copy the API key and the URL of your Supabase project.

5. Set Up Environment Variables

  • Create a new file named .env in the root directory of the project.

  • Add the following environment variables to the file:

NEXT_PUBLIC_SUPABASE_URL = your-supabase-url
NEXT_PUBLIC_SUPABASE_ANON_KEY = your-anon-key
DATABASE_URL = your-database-url

6. Start the Application

# Start the application
npm run dev

7. Open the app in your browser

You should now be able to access the application at http://localhost:3000

Contributing

We welcome contributions from the community! To get started, you can follow the steps below:

7. Create a New Branch

# Create a new branch for your feature or fix
git checkout -b feature/your-feature-name

8. Make sure your changes adhere to the project standards and structure. Stage all changes

git add .

9. Commit your Changes, with a descriptive message

git commit -m "Description of the feature or fix"

10. Push your Changes into the branch to your forked repository

# Push your branch to your forked repository
git push origin feature/your-feature-name

11. Create a Pull Request

  • Go to the original repository on GitHub and open a new Pull Request
  • Provide a clear description of your changes in the Pull Request.

12. Wait for Review

  • Once you have opened a Pull Request, the maintainers will review your changes and provide feedback.

✨ Contributors

All Thanks to our contributors 💙

GitHub Contributors