Git Product home page Git Product logo

apiv2's Introduction

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

apiv2's People

Contributors

alesanchezr avatar jefer94 avatar alexscoelho avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.