Code Monkey home page Code Monkey logo

pwp's Introduction

codecov CI

PWP SPRING 2021

Lines API

Group information

Remember to include all required documentation and HOWTOs, including how to create and populate the database, how to run and test the API, the url to the entrypoint and instructions on how to setup and run the client

Application installation

These instructions were made for Ubuntu 20.04 running Python 3.9.

  1. Create a virtual environment (optional)

    python -m venv venv
    source venv/bin/activate
  2. Install dependencies.

    ./install.sh
  3. Initialize database or apply new migrations

    ./migrate.sh
  4. Run only database tests

    pytest -v -m models
  5. Run all tests and check code syntax

    ./test.sh
  6. Start application

    ./run.sh
  7. Find api entrypoint with a client of your choice

    http://localhost:8000/api/

Web Client

See https://github.com/Stugeh/LinesClient

Admin site

Create a superuser with

python manage.py createsuperuser

Access admin site via http://localhost:8000/admin

Apidocs

Once server is up and running, check the self-hosted docs at http://localhost:8000/docs

pwp's People

Contributors

ivanmilara avatar samharju avatar stugeh avatar tha-pr avatar

Stargazers

 avatar

Watchers

 avatar  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.