rascunho

 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

# Rascunho

A small project to preview markdown notes.

This project allows you to submit a text in the markdown format and
preview the note, with no tracking and no ads. It will also generate
a link so you can share the note around.

There's also a very basic API so you can create notes using a POST
request to the endpoint at `/api/v1`.

## Infra

The documentation about the ops is available at the repo
[rascunho-etc][rascunho-etc]. There you'll find a [openrc
service][openrc] and a nginx configuration.

There's a instance deployed at [eletrotupi.com][eletrotupi] where is
using PostgreSQL and being served with nginx, but you can use whatever
kind of database compatible with SQLAlchemy like `mysql` or `sqlite`.

[eletrotupi]: https://eletrotupi.com
[openrc]: https://wiki.gentoo.org/wiki/OpenRC
[rascunho-etc]: https://git.sr.ht/~porcellis/rascunho-etc

## Running

Install the dependencies using your distro package manager, namely
`sqlalchemy`, `flask`, `humanize`, `dateutil`, `mistune` and serve with
a reverse-proxy (like nginx).

## API

There's is a pretty basic API, here's a sample using `curl (1)`:

```sh
curl -X POST \
  'https://rascunho-instance.com/api/v1' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -d '{"text": "# This is a test.\n\n Hello **world**." }'
```

## Contributing

Send patches, start discussions and other things at my
[public-inbox](mailto:~porcellis/public-inbox@lists.sr.ht).

## License

Source code available under the `GNU AGPL-3.0-or-later`, check the
LICENSE file to more info.