summaryrefslogtreecommitdiff
path: root/README.md
blob: da9ec57c4f55c578ed215d0176e3b7dbf5727d94 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
[![Build Status](https://travis-ci.org/dcariotti/stout.svg?branch=master)](https://travis-ci.org/dcariotti/stout)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/09f814cd759f4d7eaac5a650c8114fef)](https://www.codacy.com/app/dunkerC/Stout?utm_source=github.com&utm_medium=referral&utm_content=dcariotti/Stout&utm_campaign=Badge_Grade)

![logo](logo_stout.png)

> Stout è distribuito sotto licenza MIT e pertanto è possibile farne il fork, modificarlo e distribuirlo nuovamente.
La lista dei comandi è disponibile su https://github.com/dcariotti/Stout.
Scrivere info [cmd] per avere più informazioni su un comando.

Stout è un software che tramite linea di comando, e seguendo degli appositi comandi, permette di modificare la lista dei todo (cose da fare) ed eliminarli una volta fatti.

Prima di poter utilizzare Stout, bisogna installare Python3 e Flask:
```bash
sudo apt install python3
sudo pip install Flask
```

### web.py

Il software dispone di un client per il web in modo da visualizzare la lista dei todo in modo più comodo. _Necessita dell'installazione del microframework Flask_. Per avviarlo:

```bash
cd lib
FLASK_APP=web.py flask run --port=8080
```

### app.py

Il programma da terminale si trova sempre nella cartella lib:
```bash
cd lib
python3 app.py
```

## Esempio funzionamento

```bash
> (🍺 ) (santo) info add
Inserisce un nuovo todo: ogni carattere dopo add sarà considerato tale
> (🍺 ) (santo) get ctodo
2
> (🍺 ) (santo) get todo
| 0 |	 Finire la documentazione e poi inserirla su GitHub
| 1 |	 Postare tutto su Sciax2 nella sezione Progetti Rilasciati
> (🍺 ) (santo) add Andare a comprare una RedBull
Ok
> (🍺 ) (santo) get todo
| 0 |	 Finire la documentazione e poi inserirla su GitHub
| 1 |	 Postare tutto su Sciax2 nella sezione Progetti Rilasciati
| 2 |	 Andare a comprare una RedBull
> (🍺 ) (santo) del 0
Ok
> (🍺 ) (santo) get todo
| 0 |	 Postare tutto su Sciax2 nella sezione Progetti Rilasciati
| 1 |	 Andare a comprare una RedBull
> (🍺 ) (santo)
```

## Docker

```bash
docker build -t stout:latest .
docker run -i --name Stout stout:latest
```

## Screenshots (flask)
![photo1](screenshots/first.png)

![photo2](screenshots/second.png)