Author: Pedro Lucas Porcellis <pedrolucasporcellis@gmail.com>
Update README and improve config
README.md | 60 ++++++++++++++++++++++++++++++++---------------- README.pt-br.md | 34 --------------------------- config.ini.sample | 7 ++++
diff --git a/README.md b/README.md index e24c9cb9791e5803b1eb8f352ce3508f758501dd..7c8fd60e381ca1ba089204af316010ca5ce2c6d6 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,52 @@ # Rascunho -A project to express markdown notes. +Um projeto para visualizar anotações usando o formato de texto +[markdown](https://porcellis.com/markdown). -This project allow you to actually submit a markdown text and it will -give you a simple, no-ads, no tracking, no thrills preview of the text -and a link so you can share with everyone you like. +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í. -All the notes are automatically removed of the database after 7 days. +Também temos uma API para que você possa criar esses rascunhos, basta +fazer uma requisição POST em `/api/v1`. -We also expose an API so you can create notes from the command line, -just submiting (POSTing) the note to the endpoint `/api/v1`. +## Infra -## Things to Work +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]. -- Add the option to give the note a name (optional) -- Save the original blob to the database -- Rig the random url to display the preview of the note -- Handle 500/404/etc -- API -- Deploy +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`. -## Contributing +[eletrotupi]: https://eletrotupi.com +[openrc]: https://wiki.gentoo.org/wiki/OpenRC +[rascunho-etc]: https://git.sr.ht/~porcellis/rascunho-etc -Submit patches, discussions and other stuff to my [public -inbox](mailto:~porcellis/public-inbox@lists.sr.ht). +## 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). -Remember to keep a good [mailettiquete](https://people.kernel.org/tglx/notes-about-netiquette-qw89) +## Usando a API -## License +Existe uma API simples, aqui um exemplo usando `curl (1)`: -Based on AGPL, see LICENSE for more info. +```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). + +## Licença + +Utiliza a Licença `GNU AGPL-3.0-or-later`, veja o arquivo LICENSE para +mais informações. diff --git a/README.pt-br.md b/README.pt-br.md deleted file mode 100644 index 1781cbb1842c4fbd764b34103a94c2f239ad3079..0000000000000000000000000000000000000000 --- a/README.pt-br.md +++ /dev/null @@ -1,34 +0,0 @@ -# Rascunho - -Um projeto para visualizar anotações usando markdown. - -Esse projeto permite que você possa submeter um texto no formato -markdown e lhe entregar uma prévia dessa anotação, sem anuncios, sem -rastreamento. Também gera um link para que você possa compartilhar esse -texto por aí. - -Todos os textos são automaticamente deletados depois de 7 dias. - -Também temos uma API para que você possa criar rascunhos, basta fazer -uma requisição POST em `/api/v1`. - -## Coisas para trabalhar ainda - -- Adicionar a opção de poder nomear o rascunho, de forma opcional -- Salvar o texto original no banco -- Quando receber uma url, buscar no banco de dados e gerar um preview -- Lidar com errros 500 (Erro interno) e 404 (Não encontrado) -- API -- Fazer deploy - -## 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 mandar em texto puro (plain text) e fique atento as [regras -básicas de etiqueta na internet](https://people.kernel.org/tglx/notes-about-netiquette-qw89) - -## Licença - -Utiliza a Licensa AGPL, veja o arquivo LICENSE para mais informações. diff --git a/config.ini.sample b/config.ini.sample index b65fd7c9b0353017c40a414a6959e2b483e54037..e6df4bfa8f414e2a370d8485d909ea6174adb9e8 100644 --- a/config.ini.sample +++ b/config.ini.sample @@ -1,2 +1,7 @@ [meta] -env = 'dev' +env = dev + +[dev] +connection-string = postgresql://usuario:senha@host/banco +locale = pt_BR +timezone = "America/Sao_Paulo"