Skip to content

[ISSUE] Local setup process is complicated and documentation is incomplete #292

@rajatevencodes

Description

@rajatevencodes

Description

As I was going through the documentation, there are many unnecessary or incomplete sections. I used Docker for my setup, and the setup guidance is not great and also complicated. The current setup process requires too many manual steps and has several error-prone areas that make it difficult for new contributors to get started.

Steps to Reproduce

  1. Go through the README.md setup documentation
  2. Try to follow the setup instructions
  3. You will end up having errors even when following the creator's video guide
  4. Multiple manual steps are required (database setup, migrations, environment files)
  5. Missing or incorrect configuration causes authentication failures

Expected Behavior

A new contributor should be able to:

  1. Clone the repository
  2. Add the environment variables.
  3. Run a single command (like make start) - using Makefile
  4. Have everything work automatically (database, migrations, API, frontend)
  5. Successfully authenticate with Google OAuth without errors
    The setup should be simple, automated, and well-documented.

Actual Behavior

  • Documentation have incomplete Docker setup guidance
  • Requires manually a decent amount of work
  • Too many error-prone manual steps that can fail silently

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions