https://github.com/kirang89/flappi

A boilerplate application for building REST API's in Flask using Blueprints
https://github.com/kirang89/flappi

boilerplate-application flask python

Last synced: 7 days ago
JSON representation

A boilerplate application for building REST API's in Flask using Blueprints

• Host: GitHub
• URL: https://github.com/kirang89/flappi
• Owner: kirang89
• Created: 2014-04-24T22:21:02.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-04-24T22:21:44.000Z (over 10 years ago)
• Last Synced: 2024-04-16T18:23:08.716Z (7 months ago)
• Topics: boilerplate-application, flask, python
• Language: Python
• Size: 105 KB
• Stars: 0
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
#flappi

##Overview

A boilerplate application for building a REST API in Flask, using Blueprints.

##Installing

* Create a new virtual environment:

```

virtualenv env

```

* Activate the environment:

```

source env/bin/activate

```

* Install project dependencies:

```

pip install -r requirements.txt

```

##Running the application

* Create the required databases and tables:

```

python manage.py create_db

```

* Start the server:

```

python manage.py run_dev_server

```

##Testing

* To run the tests, do:

```

nosetests tests/

```

* To run the tests with coverage, do:

```

nosetests tests/ --with-coverage --cover-package=api --cover-erase

```

##Contributing

* Fork it

* Create your feature branch ```git checkout -b my-new-feature```

* Commit your changes ```git commit -am 'Add some feature'```

* Push to the branch ```git push origin my-new-feature```

* Create new Pull Request