Guider is created entirely using Django and it comes as a batteries included package. In essence, you need only this repo to get setup and running. Guider uses Postgres as it's primary database, but don't worry you don't have to install and configure postgres as there is a docker-compose included that will take care of setting up the DB with required users and other configs.
- Clone this repo
git clone https://github.com/rohittp0/guider.git
- Create a venv and activate it
- Linux / MacOs
python3 -m venv venv ./venv/bin/activate
- Windows
python3 -m venv venv venv\Scripts\activate - Install dependencies
pip install -r requirements.txt
- Rename the .env.example to .env and edit the values in it
- Set up the database
docker-compose up -d
- Apply migrations
python manage.py migrate
- Enable sign in with Google ( Optional )
python manage.py createsocial
- Create an admin user account
python manage.py createsuperuser
That's it, now you should be able to start Guider by running,
python manage.py runserverOpen http://localhost:8000 in your browser
If you are facing any problem feel free to open an issue or mail me a stack overflow question with guider as the tag. All pull requests are always welcome.
Mail me @ [email protected]
Catch me on Stackoverflow
Check out my YouTube Channel
Follow me on Instagram