Skip to content

Latest commit

 

History

History
100 lines (63 loc) · 4.58 KB

CONTRIBUTING.md

File metadata and controls

100 lines (63 loc) · 4.58 KB
Raw

Contributing to Cookied 🍪

Thank you for your interest in contributing to cookied! Whether you're a developer, designer, or enthusiast, there are many ways you can contribute to this project. Cookied is a suite of cross-platform apps designed to revolutionize how you save and organize your bookmarks.

Prerequisites Before You Start Contributing

Before diving into contributing to our project, ensure you have the following prerequisites:

  • Android Development:

  • Node.js and Yarn:

    • Make sure you have Node.js installed. If not, download it from nodejs.org.
    • Our repository uses the Yarn package manager. If you don't have Yarn installed, you can get it from yarnpkg.com.

If you have any questions or need assistance with the setup process, feel free to discuss it in our GitHub Discussions.

How Can I Contribute?

There are numerous ways you can contribute to cookied.

🐛 Report a Bug

If you encounter any issues or bugs, please report them using the Bug Report template. To expedite the resolution, kindly read the template and provide the requested information.

🛠 File a Feature Request

We welcome all feature requests, whether it's to add new functionality to Cookied or suggest modifications to existing features. File your feature request using the Feature Request template.

📚 Contribute to Docs

Help us improve the documentation for Cookied! Your contributions to the documentation play a crucial role in making the project more accessible and user-friendly.

⚙️ Contribute to Code

Let's collaborate to make Cookied flawless and elevate the user experience! You can contribute by addressing issues tagged as bug or enhancement.

Getting Started

  1. Fork and Clone the Repository:

    • Fork this repository and clone it to your local machine.

  2. Set Up Environment Files:

    • In every app directory (apps/*), you'll find example env files. Remove the .example extension and fill in the env values with your own.

  3. Install Dependencies:

    • Run yarn install to install all the necessary dependencies.

  4. Setting up Clerk Auth

  • Follow the Convex docs. In the Getting Started section,
    1. Get your Clerk Issuer URL.
      • Follow steps 1 to 4. Copy the Issuer URL
      • Duplicate the auth.config.js.example file and rename it as auth.config.js
      • Paste you Issuer URL in the domain key.
    2. Get your Clerk Publishable Key and Clerk Secret Key
      • Follow Step 7 of the same Getting Started section
      • Duplicate .env.local.example and rename it as .env.local. Paste you Clerk Publishable Key and Secret key there.
      • Do the same for env.js.example and paste you Clerk Publishable Key only

  1. Setting up Convex

    • Create a Convex project. Copy the Convex Deployment URL of your project. here a reference image for you: How to find Convex Deployment URL
    • Go to .env.local and env.js files that you created in step 4.2
    • Paste your Convex deployment URL in both the files

  2. Yarn Scripts:

    • For Android Development:

      yarn workspace native start

    • For Web App Development:

      yarn workspace web dev

    • For Chrome Extension Development:

      yarn workspace ext dev
      • After running the script, go to your browser's Extension page, turn on Dev mode, and click on 'Load Unpacked'. Load the dist/ folder (located in apps/chrome-extension).

    • For Backend:

      yarn convex dev
      • Note: You need to install Convex CLI first. Visit the Convex documentation for more information.
      • you may run npx convex dev --tail-log instead in order to get logs pipelined to your terminal

Feel free to dive in and contribute to Cookied's development journey!