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

Ricardo García Jiménez 461dd5809b fix: Corrige eliminación de diagonales en la ruta vor 3 Wochen
app 461dd5809b fix: Corrige eliminación de diagonales en la ruta vor 3 Wochen
bin 7867b6aa92 feat: Cambios menores vor 3 Wochen
config 26a1a8a3a0 feat: Agrega el subdominio en el path de las rutas vor 3 Wochen
docs 69c900de7c docs: Agrega documentación de los endpoints de las notas vor 3 Wochen
documentation 69c900de7c docs: Agrega documentación de los endpoints de las notas vor 3 Wochen
migrations 32ae7d7a98 docs: Detalla los comentarios de las migraciones, modelos y utilerías vor 1 Jahr
public 65c8b29f2a fix: Corrige redirección de las rutas en el archiv .htaccess vor 3 Wochen
routes 26a1a8a3a0 feat: Agrega el subdominio en el path de las rutas vor 3 Wochen
writable c16a0f3ef0 feat: Configura las variables de sesión vor 11 Monaten
.git-ftp-include 86db1106bc chore: Agrega configuración para git ftp vor 3 Wochen
.gitignore f486cfa39a feat: Configura los logs de la aplicación vor 4 Monaten
COPYING d906443fdd feat: Agrega estructura base de la aplicación vor 1 Jahr
README.md 69c900de7c docs: Agrega documentación de los endpoints de las notas vor 3 Wochen
bootstrap.php 627290eb45 feat: Asigna a _path_ si no existe vor 3 Wochen
composer.json f67bf2dd00 docs: Inicializa la documentación de la API con gendoc vor 4 Monaten
composer.lock f75a4f2935 chore: Actualiza dependencias de la aplicación vor 4 Monaten
env.example 26a1a8a3a0 feat: Agrega el subdominio en el path de las rutas vor 3 Wochen
prettyphp.json 91b156709c style: Agrega configuración de pretty-php a PSR-12 vor 1 Jahr

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/>.