Woreket Tracker

A web application for tracking fertilizer payments

Prerequisites

• Python 3.8+
• Pipenv
• MYSQL 5.7+

Setting up development environment

1. Clone this repo and change to the directory of the project.

2. Install the project dependencies by running the following command:

   $ pipenv install --dev

3. Make sure the MySQL Server is up and running.

4. Create a new database. (Example: woreket_tracker_db)

5. At the project root directory, there is a file named .env_example. Copy the file and rename the copy as .env.

6. Open the .env file in a text editor and add the following line.

    SECRET_KEY='<django secret key>'
    DB_NAME='woreket_tracker_db'
    DB_USER='<database user name>'
    DB_PASSWORD='<database user password>'
    DB_HOST='<host>'
    DJANGO_SETTINGS_MODULE='<setting module path. Eg. config.settings.local>'
   

   TIP: To generate a unique secret key value, you can use this website.

7. Save the file.

8. Run fixtures to load initial data.

   $ python manage.py runfixtures

9. Run the following commands to setup database schema and to create dummy data:

   $ python manage.py migrate

10. Run the following command to create an admin user:

    $ python manage.py defaultsuperuser

Usage

1. Run the following command to run the development web server:

   $ python ./manage.py runserver 0.0.0.0:8000

2. Open a web browser and go to: http://localhost:8000/admin

List of Main Tools and Packages Used

• Python 3.8+
• Pipenv
• Django 2.2
• DRF 3.9
• django-cors-headers
• celery
• redis
• Python Decouple
• Travis-CI
• Gunicorn
• django-phonenumber-field
• python-docx
• django-countries