govza / quran-words

Quran Words Project

Quran Mobi

Link to project Quran Mobi App

API

Requirements

Production:

docker, docker-compose

Development:

git, python3.6 or later, pip

Setup

Run the following terminal commands to get started:

Development

• git clone https://github.com/it-muslim/quran-words.git
• cd quran-words
• cp .env.example .env
• pip install -r django\requirements\development.txt
• python django\manage.py runserver
• python django\manage.py createsuperuser

Production

• git clone https://github.com/it-muslim/quran-words.git
• docker-machine start default
• cd quran-words
• cp .env.example .env
• Edit .env file DJANGO_EXECUTION_ENVIRONMENT line, to run project with postgres database DJANGO_EXECUTION_ENVIRONMENT=PRODUCTION and DEBUG=0
  • Windows: If it's first time you run project on machine, create volume to store persistent data (postgres) docker volume create --name=postgres and run docker-compose -f docker-compose-win.yml up
  • Linux/macOS: docker-compose up
• Check containers are running:
  • Windows: http://192.168.99.100/admin/
  • Linux/macOS: at http://127.0.0.1/admin/

Testing

You can run the tests using the following command

python django/manage.py test

Additional information can be found in our wiki

Documentation

You can access documentation by relative /api/ path of running api server API schema located at /api/schema/

Administration

Administration panel available at `http://url-or-ip-address/admin/`

Client application

Requirements

- Client built on Angular and requires Node.js version 10.9.0 or later.

Setup

Run the following terminal commands to get started: cd frontend/angular npm install npm run start access frontend at http://127.0.0.1:4200

Testing

• Karma npm run test
• Protractor npm run e2e