Domů Procházet Nápověda
Přihlásit se
ricardogj08
/
tinynote
Sledovat 1
Oblíbit 0
Rozštěpit 0
Soubory Úkoly 0

A simple markdown note taking application with encryption support built in PHP.

Strom: 6e76fde419
Větve Značky
tinynote
ZIP TAR.GZ
Ricardo García Jiménez 6e76fde419 feat: Agrega enlaces para visulizar y editar la nota en el sitio web před 1 týdnem
app 6e76fde419 feat: Agrega enlaces para visulizar y editar la nota en el sitio web před 1 týdnem
bin e4a88068e1 refactor: Renombra nombres de variables před 8 měsíci
config 931ad39a8a feat: Optimiza opciones de configuración de los logs před 1 měsícem
docs f67bf2dd00 docs: Inicializa la documentación de la API con gendoc před 1 měsícem
documentation f67bf2dd00 docs: Inicializa la documentación de la API con gendoc před 1 měsícem
migrations 32ae7d7a98 docs: Detalla los comentarios de las migraciones, modelos y utilerías před 10 měsíci
public 0f4d574451 feat: Agrega favicon del sitio web před 4 měsíci
routes 5b84b1c9e4 feat: Agrega protección contra ataques CSRF en el formulario de inicio de sesión před 1 měsícem
writable c16a0f3ef0 feat: Configura las variables de sesión před 8 měsíci
.gitignore f486cfa39a feat: Configura los logs de la aplicación před 1 měsícem
COPYING d906443fdd feat: Agrega estructura base de la aplicación před 11 měsíci
README.md 526cc99974 docs: Corrige indentación de todos los comandos del archivo README.md před 1 měsícem
bootstrap.php f486cfa39a feat: Configura los logs de la aplicación před 1 měsícem
composer.json f67bf2dd00 docs: Inicializa la documentación de la API con gendoc před 1 měsícem
composer.lock f75a4f2935 chore: Actualiza dependencias de la aplicación před 1 měsícem
env.example c30b245960 feat: Configura entorno de desarrollo para los logs před 1 měsícem
prettyphp.json 91b156709c style: Agrega configuración de pretty-php a PSR-12 před 11 měsíci

README.md

tinynote

A simple markdown note taking application with encryption support built in PHP.

Installation

Install dependencies:

cd tinynote
composer install

Copy the env.example file to .env and configure your application:

cp env.example .env

Run database migrations:

composer run migrations -- --setup

Generate JWT private key:

openssl genrsa \
  -out writable/jwt/rsa-private-key.pem \
  2048

Generate JWT public key from the private key:

openssl rsa -in writable/jwt/rsa-private-key.pem \
  -pubout \
  -outform PEM \
  -out writable/jwt/rsa-public-key.pem

Commands

Format PHP code:

composer run prettier

Generate entity-relationship diagram:

composer run gendb-diagram

Generate API documentation:

composer run gendoc

References

License

tinynote -- A simple markdown note taking application with encryption support built in PHP.

Copyright (C) 2024  Ricardo García Jiménez <ricardogj08@riseup.net>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.