Hello World

Version: 0.0.0

Add a short project description here.

Getting up and running

Minimum requirements: pip, python3.9, poetry, redis & PostgreSQL 14, setup is tested on Mac OSX only.

brew install python3 poetry libmagic postgres 

In your terminal, type or copy-paste the following:

git clone [email protected]:PrimedigitalGlobal/hello-world-backend.git; cd hello-world-backend; make install

Go grab a cup of coffee, we bake your hot development machine.

Useful commands:

• make djrun - start django server
• make deploy_docs - deploy docs to server
• make test - run the test locally with ipdb

NOTE: Checkout Makefile for all the options available and how they do it.

Docker

• Install dependencies

docker-compose run django make install

• Run Docker from project directory

docker-compose up

• After making new changed rebuild docker image

docker-compose build

Managing dependencies

Poetry

To guarantee repeatable installations, all project dependencies are managed using Poetry. The project’s direct dependencies are listed in pyproject.toml. Running poetry lock generates poetry.lock which has all versions pinned.

You can install Poetry by using pip install --pre poetry or by following the official installation guide here.

Tip: We recommend that you use this workflow and keep pyproject.toml as well as poetry.lock under version control to make sure all computers and environments run exactly the same code.

Other tools

For compatibility, requirements/production.txt and requirements/development.txt can be updated by running

poetry export --without-hashes -f requirements.txt -o requirements/production.txt.txt

and

poetry export --without-hashes -f requirements.txt -o requirements/development.txt.txt --dev

, respectively.

Deploying Project

The deployment are managed via travis, but for the first time you'll need to set the configuration values on each of the server.

Check out detailed server setup instruction here.

How to release Hello World

Execute the following commands:

git checkout master
make test
bump2version patch  # 'patch' can be replaced with 'minor' or 'major'
git push origin master
git push origin master --tags
git checkout qa
git rebase master
git push origin qa

Contributing

Golden Rule:

Anything in master is always deployable.

Avoid working on master branch, create a new branch with meaningful name, send pull request asap. Be vocal!

Refer to CONTRIBUTING.md