Write a README

This commit is contained in:
Mark Veidemanis 2022-07-21 13:46:19 +01:00
parent cac8940c8a
commit 4ddeb3f9a0
Signed by: m
GPG Key ID: 5ACFCEED46C0904F
1 changed files with 34 additions and 2 deletions

View File

@ -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.
## 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/