shahrukh-alizai/shah-101-7

This django application was built with Crowdbotics www.crowdbotics.com

shah_101_7

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

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

Development

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:

   • Linux - get.docker.com
   • Windows or MacOS - Docker Desktop

2. Clone this repo and cd shah_101_7

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

   $ docker run -it --rm -v "$PWD":/django -w /django python:3.7 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. 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) directroy will be mapped with the container meaning any edits you make will be picked up by the container.

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

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

8. 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
2. Python

Installation

1. Install pipenv
2. Clone this repo and cd shah_101_7
3. Run pip install --user --upgrade pipenv to get the latest pipenv version.
4. Run pipenv --python 3.6
5. Run pipenv install
6. Run cp .env.example .env
7. 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. Run python manage.py runserver