8000 GitHub - doio/gruik: Gruik ! An open-source markdown note-taking web app
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

doio/gruik

 
 

Repository files navigation

Gruik Logo

Gruik

Travis CI Scrutinizer Code Quality Gitter

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) Create Github OAuth application

https://github.com/settings/applications/new

2) Setup your database

mysql -u root -p

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

3) Install Composer dependencies

composer install

4) Creating database schema

php app/console doctrine:schema:create

5) 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

About

Gruik ! An open-source markdown note-taking web app

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 88.5%
  • ApacheConf 5.2%
  • HTML 4.7%
  • JavaScript 1.2%
  • CSS 0.4%
0