Skip to content

Latest commit

 

History

History

backend

README.md

testapiautosetting_138473

This is a repository for a web application developed with Django, built with Crowdbotics

Table of Contents

  1. Project Structure
  2. Features
  3. Getting Started: Backend
  4. Usage

Project Structure

..
├── home                           # Starter home app
├── modules                        # Crowdbotics Modules app
├── testapiautosetting_138473  # Django project configurations
├── static                         # Static assets
├── users                          # Starter users app
├── web_build                      # React Native Web build
├── ...
├── README.md
└── ...

Features

  1. Local Authentication using email and password with allauth
  2. Rest API using django rest framework
  3. Forgot Password
  4. Bootstrap4
  5. Toast Notification
  6. Inline content editor in homepage

Getting Started: Backend

Following are instructions on setting up your development environment.

The recommended way for running the project locally and for development is using Docker.

It's possible to also run the project without Docker.

Docker Setup (Recommended)

This project is set up to run using Docker Compose by default. It is the recommended way. You can also use existing Docker Compose files as basis for custom deployment, e.g. Docker Swarm, kubernetes, etc.

  1. Install Docker:

  2. Clone this repo and cd testapiautosetting_138473

  3. Make sure Pipfile.lock exists. If it doesn't, generate it with:

    $ docker run -it --rm -v "$PWD":/django -w /django python:3.9 /bin/bash -c "pip3 install --no-cache-dir -q pipenv && pipenv lock"

  4. Use .env.example to create .env:

    $ cp .env.example .env

  5. Update .env and docker-compose.override.yml replacing all <placeholders>

  6. Create a secret and use it in you .env file as SECRET=<new generated secret>.

    1. Use python -c 'from secrets import token_urlsafe; print("SECRET_KEY=" + token_urlsafe(50))' to generate the random.

  7. Start up the containers:

    $ docker-compose up

    This will build the necessary containers and start them, including the web server on the host and port you specified in .env.

    Current (project) directory will be mapped with the container meaning any edits you make will be picked up by the container.

  8. Seed the Postgres DB (in a separate terminal):

    $ docker-compose exec web python3 manage.py makemigrations
$ docker-compose exec web python3 manage.py migrate

  9. Create a superuser if required:

    $ docker-compose exec web python3 manage.py createsuperuser

    You will find an activation link in the server log output.

Local Setup (Alternative to Docker)

  1. Postgresql, or SQLite as an alterantive;
  2. Python;

Installation

  1. Install pipenv
  2. Clone this repo and cd testapiautosetting_138473
  3. Run pip install --user --upgrade pipenv to get the latest pipenv version.
  4. Run pipenv --python 3.9
  5. Run pipenv install
  6. Run cp .env.example .env
  7. Create a secret and use it in you .env file as SECRET=<new generated secret>.
    1. Use python -c 'from secrets import token_urlsafe; print("SECRET_KEY=" + token_urlsafe(50))' to generate the random.
  8. Update .env file DATABASE_URL with your database_name, database_user, database_password, if you use postgresql. Can alternatively set it to sqlite:////tmp/my-tmp-sqlite.db, if you want to use sqlite for local development.

Getting Started

  1. Run pipenv shell
  2. Run python manage.py makemigrations
  3. Run python manage.py migrate
  4. Start your postgres and redis using docker services:
$ docker-compose up postgres redis

You can now use their exposed ports in your .env file;

  1. Run python manage.py runserver
  2. Create a superuser if required: 
    $ python manage.py createsuperuser
    You will find an activation link in the server log output.

Usage

Admin Panel

Admin Panel can be accessed through http://localhost:8000/admin/. If you are the Project Owner, admin credentials can be generated from App > Settings on Crowdbotics App Dashboard. If not, please request your PM or Project Owner to generate admin credentials and share with you.

API Documentation

API Documentation is generated automatically and can be access through http://localhost:8000/api-docs/. Please make sure you are signed in to the admin panel before navigating to this page.

Security Configuration

The Django Backend is pre-configured to enabled certain security configurations through the use of environment variables. This can be done through the Crowdbotics Dashboard's App Settings page.

  1. https://docs.djangoproject.com/en/3.2/ref/settings/#secure-ssl-redirect

      SECURE_REDIRECT = True