burgernotes-server/README.md

21 lines
418 B
Markdown
Raw Normal View History

2024-02-26 17:25:59 +00:00
## Burgernotes
Burgernotes is a simple note-taking app with end-to-end encryption.
2023-08-31 23:31:17 +01:00
### Setup
To set up Burgernotes, simply run these commands:
```
cp config.ini.example config.ini
2024-06-21 01:46:21 +01:00
./burgernotes init_db
```
Edit config.ini to your liking, then to start the server run:
```
2024-06-21 01:46:21 +01:00
./burgernotes
```
2024-02-25 15:58:40 +00:00
### Links
2024-02-26 17:25:59 +00:00
[Go to the Burgernotes website](https://notes.hectabit.org)
2023-08-31 23:31:53 +01:00
2023-11-03 20:24:40 +00:00
[API documentation](APIDOCS.md)
2024-02-25 15:58:40 +00:00
2024-02-26 17:25:59 +00:00
[Roadmap](ROADMAP.md)