Follow the steps below to set up the project on your environment. If you run into any problems, feel free to leave a GitHub Issue or reach out to any of our communities above.
Clone this repository and cd into it:
git clone https://github.com/thenewboston-developers/Bank.git
cd Bank
Set required environment variables:
# Valid values are development, local, postgres_local, production, or staging
export DJANGO_APPLICATION_ENVIRONMENT='local'
# 64 character signing key used to authenticate network requests
export NETWORK_SIGNING_KEY='e5e5fec0dcbbd8b0a76c67204823678d3f243de7a0a1042bb3ecf66285cd9fd4'
# A string with random chars
export SECRET_KEY='some random string'
Install Redis:
brew install redis
Create a virtual environment with Python 3.6 or higher.
Install required packages:
pip3 install -r requirements/local.txt
Run Redis:
redis-server
Run Celery:
celery -A config.settings worker -l debug
To run all tests in parallel:
pytest -n auto
To monitor Celery tasks:
celery flower -A config.settings --address=127.0.0.1 --port=5555
Run:
docker-compose up # add -d to detach from console
To run all tests in parallel:
docker-compose run app pytest -n auto
# or
docker-compose exec app pytest # if docker-compose run is running
To run tests with coverage report:
docker-compose run app pytest --cov=v1
# or
docker-compose exec app pytest --cov=v1 # if docker-compose run is running
To monitor Celery tasks:
docker-compose exec celery celery flower -A config.settings --address=127.0.0.1 --port=5555
To watch log files:
tail -f logs/warning.log -n 10
When adding a package, add to requirements/base.in and then :
bash scripts/compile_requirements.sh
To generate documentation
cd docs
make html
Join the community to stay updated on the most recent developments, project roadmaps, and random discussions about completely unrelated topics.
All donations will go to thenewboston to help fund the team to continue to develop the community and create new content.
| Coin | Address |
|---|---|
 |
b6e21072b6ba2eae6f78bc3ade17f6a561fa4582d5494a5120617f2027d38797 |
 |
3GZYi3w3BXQfyb868K2phHjrS4i8LooaHh |
 |
0x0E38e2a838F0B20872E5Ff55c82c2EE7509e6d4A |
thenewboston is MIT licensed.