Gruik ! An open-source markdown note-taking web app. [ABANDONED PROJECT]

Last update: Mar 31, 2022

What is Gruik ?

It's 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.

Gruik preview

How to install ?

For now, Gruik is under hard development with regular breaking changes !

But if you want to try it :

  • Clone this repo
  • Make sure to have a database that Laravel framework supports, and edit app/config/local/database.php file.
  • composer install && bower install && php artisan migrate --seed && php artisan serve
  • Go to http://localhost:8000 and login with [[email protected] : test]

Technologies, libs & design


  • PHP 5.5+
  • Laravel Framework
  • AngularJS


Well, the best way to look for libs we use is to search in the composer file, and the bower file.

Design & Logo

Design template is the free MIT licensed template AdminLTE, and the awesome and sweet logo has been designed by MyleneLa.


The Gruik App is open-sourced software licensed under the MIT license

  • 1. Database Connectionq

    Would like to know how to get a Database Connection to MySQL. Used the following: in app/config/local/database.php

    What's wrong?

    Reviewed by weiganri at 2014-05-30 18:16
  • 2. How to install gruik?

    hi, i hv read and follow your instruction, but, it still give some error, are gruik is compatible with php 5.4?

    already edit my databse.php, but what should i import for database? is there any sql?

    when i open my site, they just show

    Warning: require(/home/sakun/public_html/gm/gruik-master/bootstrap/../vendor/autoload.php): failed to open stream: No such file or directory in /home/sakun/public_html/gm/gruik-master/bootstrap/autoload.php on line 17

    Fatal error: require(): Failed opening required '/home/sakun/public_html/gm/gruik-master/bootstrap/../vendor/autoload.php' (include_path='.:/usr/lib/php:/usr/local/lib/php') in /home/sakun/public_html/gm/gruik-master/bootstrap/autoload.php on line 17

    what do i do wrong?

    thank you, love your work

    Reviewed by brambravo at 2014-09-18 13:20
  • 3. error in readme / How to install?

    This is the software I have been searching for! In the "How to install?" chapter you mention a file app/config/local/database.php, however there's no directory called 'local' under app/config/... I'm quite sure it's app/config/database.php, is it?

    Reviewed by jniggemann at 2015-02-27 13:12
  • 4. Idea: "Private" gruik

    I'd like to use gruik with only one user (myself), other users should not be able to sign up. Is that already possible? If not, I'd like to propose this as a feature.

    Reviewed by jniggemann at 2015-05-22 11:17
  • 5. Error in migration when using sqlite

    Reproduces every time if the productions.sqlite was empty to begin with.

    $php artisan migrate --seed
    Migration table created successfully.
      SQLSTATE[HY000]: General error: 1 Cannot add a NOT NULL column with default value NULL     (SQL: alter table "users" add column "username" varchar not null)
      SQLSTATE[HY000]: General error: 1 Cannot add a NOT NULL column with default value NULL
    migrate [--bench[="..."]] [--database[="..."]] [--force] [--path[="..."]] [--package[="..."]] [--pretend] [--seed]`
    Reviewed by jniggemann at 2015-05-20 12:05
  • 6. Set the type field to "owner" if it is not specified

    Fix #37 This code was not executed when the type parameter was empty, so the date wasn't displayed. I also removed use App and use Gravatar because it was throwing an error.

    P.S: I never used Angular and I haven't done PHP for a while, so I may have done some mistakes

    Reviewed by wbrbr at 2015-05-17 10:48
  • 7. nginx config options

    Hi I set up Gruik with nginx + php5-fpm and now I get 500 error and/or framework's debug info (before I tried to create first note there were no errors). Do we need some special options in server { ... }? Currently there is:

    server {
        location / {
            try_files $uri $uri/ /index.php$is_args$args;
        location ~* \.php$ {
            try_files $uri /index.php =404;
            fastcgi_split_path_info ^(.+\.php)(/.+)$
            fastcgi_index index.php;
            fastcgi_param   SCRIPT_FILENAME     $document_root$fastcgi_script_name;
            fastcgi_param   SCRIPT_NAME         $fastcgi_script_name;
            fastcgi_param   REQUEST_URI         $request_uri;
            fastcgi_param   DOCUMENT_URI        $document_uri;
            fastcgi_param   DOCUMENT_ROOT       $document_root;
            fastcgi_param   PATH_INFO           $fastcgi_script_name;
            fastcgi_param   SERVER_PROTOCOL     $server_protocol;
            fastcgi_param   QUERY_STRING        $query_string;
            fastcgi_param   REQUEST_METHOD      $request_method;
            fastcgi_param   CONTENT_TYPE        $content_type;
            fastcgi_param   CONTENT_LENGTH      $content_length;
            fastcgi_param   SERVER_ADDR         $server_addr;
            fastcgi_param   SERVER_PORT         $server_port;
            fastcgi_param   SERVER_NAME         $server_name;
            fastcgi_param   REMOTE_ADDR         $remote_addr;
    Reviewed by bitbybit at 2014-07-10 20:00
  • 8. Unescape code in note

    Code isn't escape in a note. If I put something like:

    <script>window.location = ''</script>

    I'll be redirect, let's imagine it if a can give a public link to my note :smile:

    Reviewed by toxinu at 2014-05-04 14:58
  • 9. Abandoned or not?

    The top-of-page tagline currently reads "ABANDONED PROJECT", but the website does not have this information.

    Is this project still under development?

    Reviewed by jniggemann at 2017-09-21 20:52
  • 10. install problem: mcrypt

    PHP: 5.5.13 (compile by myself) OS: Ubuntu 14.04

    php -m:


    When running composer install, I got:

    symfony/security-core suggests installing symfony/validator (For using the user password constraint)
    symfony/security-core suggests installing symfony/expression-language (For using the expression voter)
    laravel/framework suggests installing doctrine/dbal (Allow renaming columns and dropping SQLite columns.)
    cartalyst/sentry suggests installing happydemon/txt (Required Text helpers when using the Kohana implementation)
    Writing lock file
    Generating autoload files
    Mcrypt PHP extension required.
    Script php artisan clear-compiled handling the post-install-cmd event returned with an error
      Error Output:       
    Reviewed by gwijayas at 2014-08-22 18:55
  • 11. Added API methods

    I added some API methods to access users or notes data. If you know a more elegant way to copy properties from an object to another please tell me :pray:

    Reviewed by wbrbr at 2015-05-19 18:04
  • 12. Add a REST API for creating/modifying gruiks

    As a user of Gruik, I want a REST api endpoint for creating or modifying gruiks, so that I can write a Python API, or Atom/SublimeText plugin to manage Gruiks.

    Reviewed by michaelrupert-wf at 2016-11-07 19:58
  • 13. How can I get it work without git auth e.g. oauth

    Is there any chance making it work with local user/pass auth. Also, when using oauth I can't edit nor access any of the menues, no error at all at least in apache. I was missing curl but it did say that so I assume if something else is not ok it will complain

    Reviewed by debelan at 2016-08-18 16:01
  • 14. Please help with sqlite

    Can you please instruct me, if possible, on how to use sqlite instead of mysql as the main database? I think it would benifit alot of people to have such a possibility as alot of users rather not install the whole mysql pack just to run a few small web apps on their tiny machines, and if sqlite was not implemented into the project, I will try to make a pull request for such a feature, but just wanted to ask before working on such a thing, thank you very much!

    Reviewed by vasilevich at 2016-08-08 22:18
  • 15. Add "category" field for the notes

    It would be nice to have a category field for the note (leaving the tag where it is now) so for example users can create notes inside the category "php" using tag "symfony" and so on. The search should also change allowing to filter by category. I want to to hear your opinion guys on this small suggestion.

    Reviewed by dellamina at 2016-07-20 19:06
  • 16. Shared Hosting

    Hi there, is it possbile to install Gruik on Shared Hosting (no root / no shell access). I can upload files via FTP. That is how I could "install" WordPress for example. Thank you very much for Gruik, it looks awesome.

    Reviewed by UdoKifferbrehl at 2016-07-06 09:28
Related tags
Easily add routes to your Laravel app by creating Markdown or Blade files

Laravel Pages This package lets you create pages using Markdown or Blade without having to worry about creating routes or controllers yourself. Essent

Jul 6, 2022
Better Markdown Parser in PHP
Better Markdown Parser in PHP

Parsedown Better Markdown Parser in PHP - Demo. Features One File No Dependencies Super Fast Extensible GitHub flavored Tested in 5.3 to 7.3 Markdown

Aug 11, 2022
Highly-extensible PHP Markdown parser which fully supports the CommonMark and GFM specs.
Highly-extensible PHP Markdown parser which fully supports the CommonMark and GFM specs.

league/commonmark league/commonmark is a highly-extensible PHP Markdown parser created by Colin O'Dell which supports the full CommonMark spec and Git

Aug 6, 2022
Convert HTML to Markdown with PHP

HTML To Markdown for PHP Library which converts HTML to Markdown for your sanity and convenience. Requires: PHP 7.2+ Lead Developer: @colinodell Origi

Aug 11, 2022
A PHP tool to generate templateable markdown documentation from the docblocks or type-hints of your codebase.

Roster Installation To install, simply require the package using composer: composer require

Sep 8, 2021
A highly configurable markdown renderer and Blade component for Laravel
A highly configurable markdown renderer and Blade component for Laravel

A highly configurable markdown renderer and Blade component for Laravel This package contains: a Blade component that can render markdown a highly con

Aug 13, 2022
Render colored Markdown contents on console terminal
Render colored  Markdown contents on console terminal

cli-markdown Render colored markdown contents on console terminal Preview run demo by php example/demo.php Features support auto render color on termi

Jan 27, 2022
Generate pseudo-static pages from markdown and HTML files for Flarum

Flarum Pages Generator This is not a Flarum extension. This package provides a Flarum extender that you can use in the local extend.php to define cust

Feb 21, 2022
PHP Markdown Engine Support

PHP Markdown Version v1.x support all PHP version >=5.4 v2.x support all PHP version >=7.0 Cài đặt thư viện Thư viện này được cài đặt thông qua Compos

Jul 1, 2022
markdown wiki/blog
markdown wiki/blog

Kwiki markdown wiki/blog Usage Place your markdown files in the /wiki directory. Categories are directories and subcategories are subdirectories. If y

May 29, 2022
Rendering markdown from PHP code

JBZoo / Markdown Installing composer require jbzoo/markdown Usage Rendering Table <?php declare(strict_types=1); use JBZoo\Markdown\Table; echo (new

Dec 26, 2021
Symfony 5 bundle to easily create dynamic subpages with Markdown. Useful for help sections and wikis.

MarkdownWikiBundle This bundle allows you to create rich subpages in a Symfony project using Markdown. Pages are stored in a file cache and sourced fr

Apr 26, 2022
PHP Markdown & Extra

PHP Markdown & Extra An updated and stripped version of the original PHP Markdown by Michel Fortin. Works quite well with PSR-0 autoloaders and is Com

Jan 18, 2022
A simple regex-based Markdown parser in PHP

Slimdown A simple regex-based Markdown parser in PHP. Supports the following elements (and can be extended via Slimdown::add_rule()): Headers Links Bo

Jul 27, 2022
A super lightweight Markdown parser for PHP projects and applications.

A speedy Markdown parser for PHP applications. This is a super lightweight Markdown parser for PHP projects and applications. It has a rather verbose

May 31, 2022
Docbook Tool for static documentation generation from Markdown files

Roave Docbook Tool Static HTML and PDF generator tool for generating documentation from Markdown files. Generates a deployable HTML file from Markdown

Aug 1, 2022
PHP based Markdown documentation viewer

PHP based viewer for Markdown files, to view them with fenced code highlighting and navigation.

Mar 31, 2022
Scribbl is a fast and minimalistic note-taking app built with Laravel

Scribbl is a fast and minimalistic note-taking app built with Laravel

Jul 27, 2022
My personal note-taking application.

About Laravel Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experie

Oct 31, 2021
Paperwork - OpenSource note-taking & archiving alternative to Evernote, Microsoft OneNote & Google Keep
Paperwork - OpenSource note-taking & archiving alternative to Evernote, Microsoft OneNote & Google Keep

Paperwork Paperwork is an open-source, self-hosted alternative to services like Evernote®, Microsoft OneNote® or Google Keep® <iframe src="https://pla

Aug 10, 2022