Mysterio

Anonymous chat web app

Requirements

• Python >= 3.8
• Node >= 16.13.2
• npm >= 8.1.2
• Postgres >= 13.0
• Redis >= 6.0.8

Steps for local development

1. Install python dependencies and pre-commit hook (You may need to add pipenv location to PATH)

   pip install --user pipenv
   pipenv install --dev
   pipenv shell
   pre-commit install

2. Install node modules for frontend

   cd frontend && npm install && cd ..

3. Setup postgres

   • Install & run postgres on localhost:5432(default)
   • Create a user and give CREATEDB permission to the user (for unit testing)

   createuser --interactive --pwprompt

   • Create a database

   createdb --owner=<your_user> <your_db>

4. Setup redis

   • Install & run redis on localhost:6379(default) (Use docker for easy setup)

5. Setup environment variables

   • Copy .env.example to .env
   • Replace all variables having <> with your local values
   • Add other environment variables if required

6. Apply migrations

   python manage.py makemigrations
   python manage.py migrate

7. Start the app

   python start_app.py

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT