viher3 / nottes-backend

[Backend] Nottes is a web app where you can save text notes, links and files.

Nottes backend

Nottes is a web app where you can save text notes, links and files. It's easy to use and Open Source.

Backend is built with Symfony 4 and the Frontend with Angular 5.

Screenshots

Features

Version 1 features:

• Create a notte entity
• Encrypt / decrypt nottte entities using php-encryption library
• Upload file/s
• Simple search for entities

Comming soon features:

• User management
• User roles management
• Categories management

Common installation

Install dependencies

composer install

Create database schema

php bin/console doctrine:schema:create

Create a new admin user

php bin/console fos:user:create --super-admin

You can run backend in your favorite web server or run it with the built-in web server

php bin/console server:start

Docker installation

You have to copy your SSL certificate files (fullchain.pem and privkey.pem) in the folder defined in the docker-compose.yml file:

# ./docker/prod/docker-compose.yml
/var/www/ssl_certs:/var/www/ssl_certs

You can custom the folder path:

# ./docker/prod/docker-compose.yml
/your-custom-path:/var/www/ssl_certs

Run the docker container

cd /your-app-folder/docker/prod
docker-compose up -d

Now the backend is running

https://localhost:8083

API REST documentation

You can view the API REST documentation here:

http://localhost:8000/api/doc

LICENSE

Nottes is released under the MIT Licence. See the LICENSE file for details.