Esusu societies finally digitised. Learn more about Esusu here

1. Make sure you have the following installed on your machine:

• Git: Windows, Mac. (Linux: Please install using your system's package manager)
• Docker: Windows, Mac, Linux (ensure you have the latest version).

2. Ensure that docker is running on your machine by running docker run hello-world

3. Clone (copy to your local machine) the repository using the command: git clone git@github.com:olujedai/esusu.git

4. Navigate to the esusu folder (cd esusu)

5. Set up the environment variables by running cp env.sample .env and modify the defaults.

6. Build the backend and datebase images using docker-compose build. It will take a fair bit of time the first time you do it, subsequently it will be much faster. If you get any errors, please get in touch.

7. Launch the containers using docker-compose up .

8. The first time you run the app, you may need to run the migrations to ensure that all the tables are created in the database. While the app is running (after following the previous step), run the following in another terminal/command prompt: docker-compose run esusu_api python esusu/manage.py migrate

Documentation of how to use the endpoints is found here

• pipenv install -d
• pipenv shell
• cd esusu/esusu
• python manage.py tests

• Language: Python
• Web Framework: Django
• REST API: Django Rest Framework
• Database: PostgreSQL
• OpenAPI: Yet another Swagger generator
• JWT: Simple JWT