nsmgr8 / djtodo

Task manager

djtodo - task management tool

A web based task management tool developed in django and angular.

Requirements

This code is developed in UNIX like environment and uses python and node.js. It is developed and tested in Ubuntu 18.04 but should work on any linux and macOS given the following requirements are met.

1. Python 3.6+
2. node.js 8+

It is not tested in Windows.

Deployment

Following is the instruction to install the tool in Ubuntu 18.04. It comes with a simple installation script and service configuration bundle. All of which are available at ./deploy folder.

$ sudo apt install git

$ cd /opt       # requires write permission for the current user
$ git clone https://github.com/nsmgr8/djtodo.git

$ cd djtodo
$ ./deploy/install.sh

The installer script will install all system, python and nodejs dependecies. It will build the frontend bundle to be ready to be served by nginx. It will also install a systemd service for gunicorn runner for django project.

After the successful installation, a couple more steps are required to complete the deployment. The generated nginx conf listens at port 80 which clashes with the nginx default config. So we need to either remove that or specifically target the djtodo server by a DNS name.

$ sudo rm /etc/nginx/sites-enabled/default

We also need an intial admin user. Create it with the following:

$ ./venv/bin/python ./backend/manage.py createsuperuser

We also need to create a production settings file. A minimal settings can be

$ cat <<EOF > ./backend/backend/settings_local.py

DEBUG = False

ALLOWED_HOSTS = ['djtodo.lan', '192.168.0.10']

EOF

Replace the entries in ALLOWED_HOSTS with your production DNS name and IP address.

Now restart the servers nginx and gunicorn.

$ sudo service nginx restart
$ sudo service djtodo restart

Update deployment server

When there's new update to the code, the production can be upgraded as follows:

$ cd /opt/djtodo
$ git pull
$ ./deploy/djtodo.prepare
$ sudo service djtodo restart

Development setup

Follow the steps below to setup the development environment on Ubuntu 18.04. Replace ubuntu package manager commands with your OS commands.

First of all, make sure python3.6+ and node.js is installed.

$ sudo apt install python3 python3-pip python3-venv
$ python3 --version     # must be >3.6

$ sudo apt install nodejs npm
$ nodejs -v             # must be >8
$ sudo npm install -g npm  # upgrade npm
$ suod npm install -g npx

Grab the code from github

$ git clone https://github.com/nsmgr8/djtodo.git
$ cd djtodo

Create a python virtualenv and prepare it for the dev.

$ python3 -mvenv venv
$ source venv/bin/activate
$ pip install -r requirements.txt

Create and setup the django db

$ ./backend/manage.py migrate
$ ./backend/manage.py createsuperuser # use creds: admin password

Install all frontend requirements

$ pushd frontend
$ npm install
$ popd

Development servers

Now it is time to run the servers. There are two dev servers available for ease of development. The backend and frontend are independent of each other.

The backend development server can be run as following (make sure you are in the python virtualenv):

$ source ./venv/bin/activate
$ ./backend/manage.py runserver

This will start a django dev server at localhost:8000.

The frontend development server is a webpack devserver which can be started as following:

$ cd frontend
$ npm start -- -o

This will start the webpack server at localhost:4200 compiling the angular source code. It will also open the index page at http://localhost:4200/ in the default browser.

This is auto-refreshed server. That is, it will watch the frontend source files for change and auto-refresh the browser.

Running tests

There are two types of automated tests available in this project. A django test runner and a cypress end-to-end test runner.

To run the django test, follow the commands below:

$ source ./venv/bin/activate
$ cd backend
$ ./manage.py test

To run the e2e test run the following:

$ source ./venv/bin/activate
$ cd backend
$ gunicorn backend.wsgi &

$ cd ../frontend
$ npx cypress run

The above will run the e2e tests in headless mode. To run the e2e tests in a browser with interaction, run the following

$ npx cypress open

This will open the list of all tests in cypress UI where one can select which test to run in an embedded browser.

Documentation generation

The project has source code docstring based documentation generator. The system is built on top of sphinx and compodoc. To build the documentation run the following:

$ cd doc
$ ./build.sh
$ open build/html/index.html

This will open the documentation sites index page in your default browser.