Skip to content

shmolf/noted

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Note'd

The note'd app is a note-taking application, using the MarkDown syntax. There's added support, for Graphs via Apex Charts, and some FrontMatter, via custom implementation.

The end-goal, is that the application is broken up into 2 primary repos, with a third, independent repo for request hydration. Ideally, this repo would be responsible for the frontend presentation, and browser-side application. The other (tbd) repo would house only the server-side logic for recieving and storing notes sent by the note'd website.

Setup

Create an .env.local file, with the following environment variables (assign values according to your setup).

# This application uses Doctrine, so use a DSN that's compatible with that ORM. Doesn't have to be MySQL.
DATABASE_URL=mysql://someuser:somepassword@127.0.0.1:3306/databaseSchemaName?serverVersion=8.0.25&charset=utf8mb4
DATABASE_VERSION='8.0.25'
# use 'dev' for the APP_ENV if you're wanting Debugging capabilities. See Symfony docs for more info
APP_ENV=prod
APP_SECRET=yourApplicationSecret
$ composer install;
yarn install;
cd node_modules/codemirror && yarn install && cd ../../;
yarn run build;

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Since this is still using the codemirror npm package, be sure to run the following command after you install the package. This'll auto-generate the build files. Of course, this command is already referenced in Setup.

cd node_modules/codemirror && yarn install

Security

If you discover any security related issues, please email the author instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

About

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published

Contributors 3

  •  
  •  
  •