-
Notifications
You must be signed in to change notification settings - Fork 191
Open
Labels
bugSomething isn't workingSomething isn't working
Description
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
- Go through the README.md setup documentation
- Try to follow the setup instructions
- You will end up having errors even when following the creator's video guide
- Multiple manual steps are required (database setup, migrations, environment files)
- Missing or incorrect configuration causes authentication failures
Expected Behavior
A new contributor should be able to:
- Clone the repository
- Add the environment variables.
- Run a single command (like
make start) - using Makefile - Have everything work automatically (database, migrations, API, frontend)
- 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
Labels
bugSomething isn't workingSomething isn't working