diff --git a/README.md b/README.md index ccabdf32f..731340df8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ # fedireads Social reading and reviewing, decentralized with ActivityPub + +## Setting up the developer environment +You will need postgres installed and running on your computer. + +``` bash +python3 -m venv venv +source venv/bin/activate +pip install -r requirements.txt +createdb fedireads +``` + +Create the psql user in `psql fedireads`: +``` psql +CREATE ROLE fedireads WITH LOGIN PASSWORD 'fedireads'; +GRANT ALL PRIVILEGES ON DATABASE fedireads TO fedireads; +``` + +Initialize the database +``` bash +./rebuilddb.sh +``` +This creates two users, `mouse` with password `password123` and `rat` with password `ratword`. + +And go to the app at localhost:8000 + +For most testing, you'll want to use ngrok. Remember to set the DOMAIN in settings.py to your ngrok domain.