Updated README
This commit is contained in:
parent
f0ee511c21
commit
dfce913246
78
README.md
78
README.md
|
@ -5,34 +5,58 @@ Jeeves will take care of your boring tasks so you don't have to worry.
|
|||
![Python 3.7+](https://img.shields.io/badge/python-3.7%2B-blue)
|
||||
|
||||
- [Jeeves](#jeeves)
|
||||
- [Installing](#installing)
|
||||
- [Running it](#running-it)
|
||||
- [Using the cli](#using-the-cli)
|
||||
- [Contributing](#contributing)
|
||||
- [Running locally](#running-locally)
|
||||
- [Accessing the web interface](#accessing-the-web-interface)
|
||||
- [Running the test suite](#running-the-test-suite)
|
||||
|
||||
## Installing
|
||||
|
||||
Clone the repository and install it using poetry:
|
||||
|
||||
```
|
||||
git clone git@github.com:fmartingr/jeeves.git
|
||||
cd jeeves
|
||||
poetry install
|
||||
```
|
||||
|
||||
## Running it
|
||||
|
||||
### Using the cli
|
||||
|
||||
Jeeves provide a useful CLI to execute your flows in a very convenient way, for example. given a test flow:
|
||||
|
||||
``` javascript
|
||||
// definition.json
|
||||
{
|
||||
"name": "Test flow",
|
||||
"tasks": [
|
||||
{
|
||||
"name": "Say hello",
|
||||
"type": "jeeves.core.tasks.shell:ShellTask",
|
||||
"parameters": {
|
||||
"script": "#!/bin/bash\necho HELLO WORLD!"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
You can run it using `jeeves execute definition.json`:
|
||||
|
||||
```
|
||||
$ jeeves execute --output definition.json
|
||||
(i) Running flow from definition.json
|
||||
=== Running flow: Test flow
|
||||
ok! Running step [1/1]: Say hello
|
||||
=== Full output:
|
||||
HELLO WORLD
|
||||
```
|
||||
|
||||
> You can also run the same command from stdin using:
|
||||
> - `cat definition.json | jeeves execute --output -`
|
||||
> - `jeeves execute --output - < definition.json`
|
||||
|
||||
## Contributing
|
||||
|
||||
### Running locally
|
||||
|
||||
A [docker-compose](https://docs.docker.com/compose/) file is prepared if you want to run the project effortlessly, just make sure you have it updated and run:
|
||||
|
||||
```
|
||||
docker-compose run --rm backend make quicksetup
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
The webserver will be running on port 8000 by default.
|
||||
|
||||
### Accessing the web interface
|
||||
|
||||
To run the webserver run this and then access [http://localhost:8000/admin](http://localhost:8000/admin) with credentials `admin`/`Qwer1234`.
|
||||
|
||||
The provided frontend is available at [http://localhost:8000/dashboard](http://localhost:8000/dashboard).
|
||||
|
||||
### Running the test suite
|
||||
|
||||
To run the test suite:
|
||||
|
||||
``` bash
|
||||
DJANGO_SETTINGS_MODULE=jeeves.settings pytest .
|
||||
```
|
||||
TODO
|
||||
|
|
Reference in New Issue