https://github.com/nirgn975/apistar-talk
https://github.com/nirgn975/apistar-talk
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/nirgn975/apistar-talk
- Owner: nirgn975
- License: isc
- Created: 2017-08-29T16:29:28.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-10-09T08:26:13.000Z (over 3 years ago)
- Last Synced: 2025-05-14T22:11:54.452Z (about 1 year ago)
- Language: Python
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# API Star - Talk
[![license][license-image]][license-url]
This is a simple CRUD app written with [API Star](https://github.com/encode/apistar).
## Pre Requirements
1. [Python3](https://python.org).
2. [MongoDB](https://www.mongodb.com/).
## Installation
1. Run MongoDB `mongod`
2. Install requirements with `pip3 install -r requirements.txt`
3. Run API Star `apistar run`
4. Hit the API at [http://localhost:8080](http://localhost:8080)
## API
To look at and play with the API you can go to [http://localhost:8080/docs](http://localhost:8080/docs)
## Tests
Run the tests by execute `apistar test`
## Run for production
Use `uvicorn` to run the app, and change `--workers` flag to how many CPU cores you have on the server
```
$ uvicorn app:app --workers=4 --bind=0.0.0.0:5000 --pid=pid
```
[license-image]: https://img.shields.io/badge/license-ISC-blue.svg
[license-url]: https://github.com/nirgn975/apistar-talk/blob/master/LICENSE