ref: 0.0.3
./README.md
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 |
# Rascunho > There's a english version of this [README][readme-en]. [readme-en]: https://git.sr.ht/~porcellis/rascunho/tree/master/README-en.md Um projeto para visualizar anotações usando o formato de texto [markdown](https://porcellis.com/markdown). Esse projeto permite que você possa submeter um texto no formato markdown e pré-visualizar a anotação, sem anuncios, sem rastreamento. Também gera um link para que você possa compartilhar esse texto por aí. Também temos uma API para que você possa criar esses rascunhos, basta fazer uma requisição POST em `/api/v1`. ## Infra Documentação da infra está no repositório [rascunho-etc][rascunho-etc], onde tem o arquivo de configuração do nginx e um serviço para o [openrc][openrc]. A instância hospedada no [eletrotupi.com][eletrotupi] está usando PostgreSQL e nginx, mas pode ser usado qualquer tipo de banco de dados compatível com o SQLAlchemy, de saida pode ser usado `mysql` e `sqlite`. [eletrotupi]: https://eletrotupi.com [openrc]: https://wiki.gentoo.org/wiki/OpenRC [rascunho-etc]: https://git.sr.ht/~porcellis/rascunho-etc ## Rodando Instale as dependencias usando seu gerenciador de pacotes, `sqlalchemy`, `humanize`, `flask`, `mistune`, `dateutil` e sirva o projeto embaixo de um proxy reverso (recomendo o nginx). ## Usando a API Existe uma API simples, aqui um exemplo usando `curl (1)`: ```sh curl -X POST \ 'https://instancia-do-rascunho/api/v1' \ -H 'Content-Type: application/json; charset=utf-8' \ -d '{"text": "# Isso é um teste.\n\n Olá **mundo**." }' ``` ## Contribuir Mande patches, comece discussões e outras coisas na minha [caixa de entrada pública](mailto:~porcellis/public-inbox@lists.sr.ht), lembre-se de usar [emails apenas texto][apenas-texto]. [apenas-texto]: https://apenastexto.eletrotupi.com ## Licença Utiliza a Licença `GNU AGPL-3.0-or-later`, veja o arquivo LICENSE para mais informações. |