Diary is an online journal where users can pen down their thoughts and feelings. You can also use it to track your online reading list by adding links to read later and mark them as read once read for convenience.

The building blocks are:

• Python 3.5
• Django 2.1
• PostgreSQL

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

You need the following to be able to run the project:

• Python 3 installed
• Virtualenv
• Postgres (9.4+)
• Docker (Optional)

These are instructions for setting up Diary API in development environment.

• prepare directory for project code and virtualenv:

  $ mkdir -p ~/drfdiary_project
  $ cd ~/drfdiary_project

• prepare virtual environment (with virtualenv you get pip, we'll use it soon to install requirements):

  $ virtualenv --python=python3 venv-drfdiary
  $ source venv-drfdiary/bin/activate

• check out project code:

  $ git clone https://github.com/ro6ley/drf-diary.git

• install requirements (Django, ...) into virtualenv:

  $ pip install -r drf-diary/requirements.txt

• make sure PostgreSQL server is installed and running, create database "drfdiary_dev":

  $ psql --user postgres
  postgres=# create database drfdiary_dev;

• create database tables:

  $ cd ~/drfdiary_project/drf-diary/drfdiary
  $ ./manage.py makemigrations
  $ ./manage.py migrate
  $ ./manage createsuperuser

• run development server:

  $ ./manage.py runserver

The site should now be running at http://localhost:8080/.

To log into Django administration site as a super user, visit http://localhost:8080/admin

Once up and running the documentation is available at: http://localhost:8080/docs

The endpoints in summary:

Database configuration is stored in drfdiary/settings/development.py. The default database engine is Postgres.

To use SQLite, update drfdiary/settings/development.py as follows:

  DATABASES = {
      'default': {
          'ENGINE': 'django.db.backends.sqlite3',
          'NAME': 'drfdiary_dev.db',
      }
  }

To run the tests:

  $ cd ~/drfdiary_project/drf-diary/drfdiary
  $ ./manage.py test --settings=settings.testing

Alternatively, you can create a docker image for development as well. This image will contain an instance of the application running with django's development server using a sqlite database and can be used to quickly setup a development instance.

• Update the Database settings to use sqlite3:

    DATABASES = {
        'default': {
            'ENGINE': 'django.db.backends.sqlite3',
            'NAME': 'drfdiary_dev.db',
        }
    }
  

• Run the following commands:

    # Build the Docker Image
    $ docker build -t drfdiary_dev .
  
    # Run it
    $ docker run -dt -p 8000:8000 drfdiary_dev
    
    # Get the Container ID for the next step
    $ docker ps | grep drfdiary_dev
  
    # Create a super user
    $ docker exec -it <container_id> python drfdiary/manage.py createsuperuser
  
    # View the documentation at 127.0.0.1:8000/docs 
  

• Django - The web framework used
• Django REST Framework - The framework used to build the API
• Django REST Auth - Django-rest-auth provides a set of REST API endpoints for Authentication and Registration

• Robley Gori - Initial work

See also the list of contributors who participated in this project.

This project is licensed under the MIT License.