Skip to content

Latest commit

 

History

History
47 lines (27 loc) · 1.24 KB

README.rst

File metadata and controls

47 lines (27 loc) · 1.24 KB

logo

Tornado-based boilerplate for API projects

https://travis-ci.org/gakhov/api.boilerplate.svg?branch=master https://coveralls.io/repos/github/gakhov/api.boilerplate/badge.svg?branch=master

How to start

First, you need to clone or fork our API boilerplate. If you choose clone, go to your machine and run

$ git clone git@github.com:gakhov/api.boilerplate.git myfolder
$ cd myfolder

Afterwards you need to add your remote to the git repository to be able commit your changes:

$ git remote rename origin boilerplate
$ git remote add origin https://github.com/{user}/{your_repo}.git

Documentation

How to run

$ bin/start_server -h
usage: start_server [-h] [--name NAME] [--port PORT] [--settings SETTINGS]
$ bin/start_server --name server --port 5570