Git Product home page Git Product logo

huskar's Introduction

Huskar API

HTTP API of Huskar: http://example.com/huskar_api/

How to start

$ cp .env.example .env && vim .env

Starting the API server in local environment:

$ . path/to/venv/activate
$ make install-deps
$ honcho start

Starting the API server in Docker:

$ docker-compose run --rm wsgi initdb      # initialize database
$ docker-compose run --rm wsgi initadmin   # initialize administrator
$ docker-compose up wsgi                   # start web server

Development FAQ

Using the ZooKeeper CLI:

$ zkCli -server $(docker-compose port zookeeper 2181)

Using the MySQL CLI:

$ mycli mysql://root@$(docker-compose port mysql 3306)/huskar_api

Updating dependencies:

$ docker-compose run --rm wsgi make compile-deps
$ git add -p requirements*

Running tests:

$ docker-compose run --rm wsgi testall -xv
$ docker-compose run --rm wsgi test test_foo.py -xv

Maintaining database schema:

$ docker-compose run --rm wsgi alembic upgrade head
$ vim huskar_api/models/foobar.py
$ docker-compose run --rm wsgi alembic revision --autogenerate -m 'add an index of foo'
$ vim database/migration/versions/xxxxxxx.py
$ docker-compose run --rm wsgi alembic upgrade head
$ docker-compose run --rm wsgi dumpdb
$ git add database

Updating snapshot of email template in tests:

$ docker-compose run --rm wsgi python run.py tests.test_extras.test_email:gen

huskar's People

Contributors

mozillazg avatar

Watchers

 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.