weni-marketplace-engine

This project provides so many API endpoints to manage Weni Platform marketplace.

Running project for development

Requirements

• Python ^3.8
• Poetry ^1.0

Installation

To run this project, we will need Poetry installed on your machine.
After installing poetry, install all dependencies using (on project root path):

$ poetry install

To enter on Poetry virtual environment, we use:

$ poetry shell

Environment setting

In this project we use environment variables to make most of the configurations. To speed up the project installation process we use a script to generate our .env file, it can be found in contrib/gen_env.py. To use type:

$ python contrib/gen_env.py

Ready, an .env file should be appars on root of project, and from it we can configure our environment variables.

OBS: The use of this script is recommended in development environment only.

Setting up the local database

To get the database up and running, docker-compose can be handy:

$ docker-compose up -d database

Run the necessary migrations with:

$ python manage.py migrate

Executing the application

To run the application, you can use:

$ python manage.py runserver 8001

Environment Variables list: