Skip to content

Add local development setup guide and .env.example #3

Description

@guptavernit2-afk

Description

The project README mentions setting up crypto keys and provider tokens in a .env file, but there is currently no .env.example file available. The setup instructions also do not clearly explain how to run both the backend and the Next.js frontend locally.

Current Behavior

New contributors have to guess the required environment variables and commands needed to start the complete project locally. This can make the setup process confusing, especially for first-time contributors.

Expected Behavior

The repository should include:

  • A sample .env.example file with placeholder values
  • Clear backend setup commands
  • Clear frontend setup commands
  • Instructions for running both servers locally
  • Any required environment variables documented properly

Why this is useful

This will make the project easier to set up for new contributors and reduce onboarding friction during GSSoC 2026.

Possible Fix

Add a .env.example file and update the README with a proper local development setup section, including dependency installation and run commands for both frontend and backend.

I would like to work on this issue under GSSoC 2026 if it is approved.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions