This commit is contained in:
Justine Pelletreau
2022-04-04 15:16:48 +02:00
parent c923e4b7f2
commit aa6a0f8e5e
8 changed files with 120 additions and 31 deletions

View File

@ -1,15 +1,15 @@
# squip_notes
# squip_tasks
This is a basic notes-taking program. It uses python with flask and pickle, to give a really light and simple web interface for note taking.
This is a basic todo program. It uses python with flask and pickle, to give a really light and simple web interface for task taking.
It uses the [dracula](https://github.com/dracula/dracula-theme) colors.
![dark theme screenshot](./ssdark.png)
![light theme screenshot](./sslight.png)
![Screenshot of the application](./squipnotes.png)
![Screenshot of the application](./squiptasks.png)
# Features
* No accounts : this is made to be used as a single page (you can't have multiple user accounts). This is best suited as a personnal, self-hosted application in your own network (or it could also work for a work team).
* Simplicity: Simply get on the page and start writing. The notes syntax is markdown.
* Simplicity: Simply get on the page and start writing. The tasks syntax is markdown.
* Themes : As for now, there is a default dark theme (dracula), and an optionnal light theme (loosely based on solarized light). They can be selected via the interface.
# Themes (adding your own)
@ -34,7 +34,7 @@ pygmentize -S dracula -f html -a .codehilite > styles.css
## Run with Docker
### Using traefik
If you use traefik, you only have to change the url in the label "traefik.http.routers.sqnotes.rule". You can also modify the labels to rename the service from "sqnotes" to anything else.
If you use traefik, you only have to change the url in the label "traefik.http.routers.sqtasks.rule". You can also modify the labels to rename the service from "sqtasks" to anything else.
Then start the service. It will create the image and start it for you:
```bash