From 4ddeb3f9a09b559fc3efebe5b70d7ecf275b1214 Mon Sep 17 00:00:00 2001 From: Mark Veidemanis Date: Thu, 21 Jul 2022 13:46:19 +0100 Subject: [PATCH] Write a README --- README.md | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ed7ad2f..dd43b3d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,35 @@ -# neptune +# Neptune +Django app to handle to manage subscriptions to products using Stripe, and implementation of the products themselves. -Django app to handle to manage subscriptions to products using Stripe, and implementation of the products themselves. \ No newline at end of file +## Setting up the environment +Create the virtual environment, enable it, and install the dependencies. +```shell +$ python3 -m venv venv +$ source env/bin/activate +(env) $ pip install -r requirements.txt +``` + +## Running database migrations +Now we need to run the database migrations in order to get a working database. +```shell +(env) $ python manage.py migrate +``` + +## Creating a superuser +In order to access Django admin, we need a superuser. +```shell +(env) $ python manage.py createsuperuser +Username: t2 +Email address: t2@google.com +Password: +Password (again): +Superuser created successfully. +``` + +## Running the server +```shell +(env) $ python manage.py runserver 8001 +Starting development server at http://127.0.0.1:8001/ +Quit the server with CONTROL-C. +``` +As you've guessed, you can access it at http://127.0.0.1:8001/