install docker and docker-compose
install docker windows https://docs.docker.com/desktop/install/windows-install/ install docker ubuntu https://docs.docker.com/engine/install/ubuntu/ install docker mac https://docs.docker.com/desktop/install/mac-install/
install node para el front -> https://nodejs.org/en/download install python for el back -> https://www.python.org/downloads/
hay que crear su archivo .env para esto
pueden copiarlo con el $ cp .env.example .env que eso copiara el .env.example a un .env
si tienen otras variables de entorno aparte de las que estan en el examples traerselas del gitpod
ejecutar el $ docker-compose up para levantar la base de datos
ejecutar en un terminal $ docker-compose exec -it postgres /bin/bash.
en caso de user ubuntu $ sudo docker-compose exec postgres bash
luego entrar en la base de datos: $ psql
crear la base de datos example $ create database example;
comprobar que existe con $ \l
luego ejecutar el $ pipenv shell
despues el $ pipenv install
luego el $ npm install
antes de levantar el entorno compiarse del .env.example las variables de entorno del DATABASE_URL y el BACKEND_URL que tienen el comentario de IN LOCAL
luego si hace falta ejecutar:
$ pipenv run init -> si no existe carpeta de migraciones
$ pipenv run migrate
$ pipenv run upgrade
a continuación ejecutar el:
$ pipenv run start
$ npm run start
- Install the python packages:
$ pipenv install - Create a .env file based on the .env.example:
$ cp .env.example .env - Install your database engine and create your database, depending on your database you have to create a DATABASE_URL variable with one of the possible values, make sure you replace the valudes with your database information:
| Engine | DATABASE_URL |
|---|---|
| SQLite | sqlite:////test.db |
| MySQL | mysql://username:password@localhost:port/example |
| Postgress | postgres://username:password@localhost:5432/example |
- Migrate the migrations:
$ pipenv run migrate(skip if you have not made changes to the models on the./src/api/models.py) - Run the migrations:
$ pipenv run upgrade - Run the application:
$ pipenv run start