بِسْمِ ٱللَّٰهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ

bless_server

Server API used for Bless app (and other apps) / Standalone Qur'an (WORK IN PROGRESS)

How-to

Install Python

Download

Install pipx (Optional)

Run this command:

python3 -m pip install --user pipx

Ensure path (after installing pipx)

Don't forget to run this command after installing pipx:

python3 -m pipx ensurepath

Install Poetry

If you use pipx, you can just run this command:

pipx install poetry

Or: Installation Docs

Have a copy of this repository

You can use Git (and GitHub) tutorial linked below for conscise beginner-friendly tutorials

Install dependencies with Poetry

Run this command on the root folder of the project:

poetry install --with=dev

Activate the virtual environment

Run this command on the root folder of the project:

poetry shell

Install pre-commit git hook scripts (very important)

Run this command on the root folder of the project:

pre-commit install

Run the migrate command

Run this command on the root folder of the project:

python3 manage.py migrate

Load fixture(s)

To populate the database with some data. Load An-Nas fixture

Run the server

Run this command on the root folder of the project:

python3 manage.py runserver

Develop using Visual Studio Code

1. Rename bless_server.code-workspace.dist located on the root folder of the project to bless_server.code-workspace

2. Open the bless_server.code-workspace

3. Install these extensions:

   Python

   Black

   Prettier (Prettier doesn't work well for Django HTML yet, so it only be used for css only)

Source

For An-Nas: Qur'an Kemenag

Please

For commit message

A written example: Created `AUTHORS`

So, it will be seen like this: Created AUTHORS

Sorry, if I also did many inconsistencies :(

Use verb 3

"Created"

Please add "`" charater to the start and the end of an object

"`AUTHORS`"

See these tutorials

Django Docs

GIT & GITHUB by Sandhika Galih (Indonesian)

Git and GitHub for Beginners - Crash Course

Python Django Web Framework - Full Course for Beginners

Django For Everybody - Full Python University Course

Python Backend Web Development Course (with Django)

Dear Authors

Don't forget to add yourself in AUTHORS file, if you contributed to this project (and haven't done that yet)