updated README.md with usage info

master
androiddrew 7 years ago
parent 830340b448
commit 9d073da12e

@ -4,12 +4,33 @@ An API Star template for [cookiecutter](https://github.com/audreyr/cookiecutter)
## Usage ## Usage
```python ```python
$ pip install cookiecutter $ pip install cookiecutter
$ cookiecutter https://git.androiddrew.com/androiddrew/cookiecutter-apistar.git $ cookiecutter https://git.androiddrew.com/androiddrew/cookiecutter-apistar.git
``` ```
You will be asked for some basic information regarding your project (name, project name, etc.). This info will be used in your new project You will be asked for some basic information regarding your project (name, project name, etc.). This info will be used in your new project
#### Create virtual env
```
$ cd <app_dir>
$ python -m venv env
$ source env/bin/activate
$ pip install -r requirements
#### Run tests
```
$ pytest -v
```
OR
```
$ python wsgi_app.py test
```
#### Run dev server
```
$ python wsgi_app.py run
```
## License ## License
MIT Licensed. MIT Licensed.

Loading…
Cancel
Save