https://github.com/cortisolai/getting-started-example
Getting started example for Cortisol
https://github.com/cortisolai/getting-started-example
Last synced: 3 months ago
JSON representation
Getting started example for Cortisol
- Host: GitHub
- URL: https://github.com/cortisolai/getting-started-example
- Owner: CortisolAI
- License: mit
- Created: 2023-08-13T11:39:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-19T12:47:37.000Z (almost 2 years ago)
- Last Synced: 2025-01-20T12:25:14.215Z (4 months ago)
- Language: Python
- Size: 4.88 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# getting-started-example
Getting started example for Cortisol
## How to run it
### Option 1
It requires the one of the following Python versions: 3.8, 3.9, 3.10 or 3.11.
Also, you need to install some requirements:
- Create a virtualenv. For example: `mkvirtualenv getting-started-cortisol`
- Install the requirements `pip install -r requirements.txt`
And, finally, you can it locally:
`python -m app.main`
### Option 2
Run it in a Docker container
- `make build` to build the Docker image
- `make run` to run the container. The service will be available at `http://localhost:8080/`. It will output the container id, too.
- `make stop` to stop the container
- `make clean` to delete the image and the container