Skip to content

Commit

Permalink
Improved Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Grau committed Aug 19, 2014
1 parent c8dfd1f commit 54ecced
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,25 @@
This is a simple bootstrapped Flask Website + API using Flask-Restless, Flask-Security, SQLAlchemy and
JWT tokens for authentication.
This is a simple bootstrapped [Flask](http://flask.pocoo.org/) website + API using:

Credits go to Nic for providing the basic idea:
http://stackoverflow.com/a/24258886/700283
- [Flask-Restless](https://flask-restless.readthedocs.org/en/latest/) (API)
- [Flask-Security](https://pythonhosted.org/Flask-Security/) (Authentication)
- [Flask-JWT](https://pythonhosted.org/Flask-JWT/) (API authentication)
- [SQLAlchemy](http://www.sqlalchemy.org/) (ORM)

Plus stubs for

I changed the structure quite a bit and added stubs for testing and templates.
- Templates
- Testing

I got the basic idea from Nic:
http://stackoverflow.com/a/24258886/700283

Setup
=====

- Setup vitualenv
- Create and activate a vitualenv
- Run `pip install -r requirements.txt`
- Start server using `python server.py`


**API auth**

- POST /auth {'username': '', 'password': ''}
Expand Down

0 comments on commit 54ecced

Please sign in to comment.