Skip to content

paocastrob/apiv2

 
 

Repository files navigation

Setup & Installation

  1. Install redis, postgress, python 3.8+ and node 14+
  2. Create enviroment variables cp .env.example .env (make sure to fill the variables with relevant values)
  3. Make sure to get inside the environment: pipenv shell
  4. Install the dependencies including development packages: pipenv install --dev
  5. Run the migrations into your database pipenv run migrate
  6. Run the fixtures to add sample data: pipenv run python manage.py loaddata breathecode/*/fixtures/dev_*.json
  7. Make sure you can login into the django admin, you can create a login user with python manage.py createsuperuser

Setup & Installation with Docker

  1. Generate the Breathecode Docker image pipenv run docker_build
  2. Create enviroment variables cp .env.example .env (make sure to fill the variables with relevant values)
  3. Run containers with docker-compose up -d
  4. Make sure you can login into the django admin, you can create a login user with docker-compose exec breathecode python manage.py createsuperuser

Dumentation for BreatheCode API

Read the docs

Additional Resources

Online editor

Gitpod

Run the tests

pipenv run test ./breathecode/

Run coverage

Report with HTML

pipenv run coverage breathecode

Fixtures

Fixtures are fake data ideal for development.

Saving new fixtures

python manage.py dumpdata auth > ./breathecode/auth/fixtures/users.json

Loading all fixtures

pipenv run python manage.py loaddata breathecode/*/fixtures/dev_*.json

Icons

The following icons arebeing used for the slack integrations: https://www.pngrepo.com/collection/soft-colored-ui-icons/1

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 97.0%
  • HTML 2.8%
  • Other 0.2%