helmithejoe / gruik Goto Github PK

Gruik

Gruik is a free & open-source note-taking service. A space where you can store notes, tutorials, code snippets... by writing them in markdown and then keep them private or public.

Prerequisite

• PHP 5.6+
• MySQL
• Composer
• NodeJS & NPM (only used to grab front JS dependencies)

Installation

Gruik is based on the great Symfony framework. If you encounter some installation errors, please have a look on the Symfony installation documentation. If you still have some troubles, feel free to ping someone on Gitter or open a GitHub issue.

1) Setup your database

mysql -u root -p

CREATE DATABASE gruik;
GRANT ALL PRIVILEGES ON gruik.* TO gruik_user@localhost IDENTIFIED BY 'gruik_password';
EXIT

2) Install Composer dependencies

composer install

3) Install frontend assets

npm install # Install frontend dependencies, like Bootstrap
php app/console assets:install # Move bundle assets to web/ directory
nodejs node_modules/gulp/bin/gulp.js less # Compile bundle .less files to .css
nodejs node_modules/gulp/bin/gulp.js install # Move downloaded assets to web/ directory

License

The Gruik App is open-sourced software licensed under the GNU General Public License v 3.0