mgxit / burnernote Goto Github PK

Burnernote Send secure and encrypted notes that self destruct once they've been read. It is designed to be:

• Ad Free and simple. No clutter, no bloat, no complex dependencies. Burnernote is built with PHP so it’s quick and easy to deploy.

• Open-source and Beautiful. Burnernote is open source and available on github.

• Set password. Set an optional password for the self-destructing messages.

• Auto self destruct. The note will expire after a set number of days, default to 7 days

• Clone the repository.

git clone https://github.com/Gigamick/burnernote.git

• Change current working directory

cd burnernote

• Make sure php is ^8.0

php -v

• Install composer dependencies

composer install

• Copy .env file

cp .env.example .env

• Edit database credentials in .env file

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=burnernote
DB_USERNAME=root
DB_PASSWORD=root

• Edit app url to 'https://burnernote.test' since assets are served through secure url

• Generate app key and migrate database

php artisan key:generate
php artisan migrate

• Serve site through valet

valet link
valet secure

• visit 'https://burnernote.test' in the browser

If you discover a security vulnerability within Burnernote, create an issue.

Burnernote is open-source software licensed under the GNU License.