diff --git a/README.md b/README.md index d6e26c62..b1bd5877 100755 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ ![alt text][logo] -Caisse | Cipherbliss +Caisse | Cipher Bliss ==== -Self hosted Cash register and money management for your small business. +Self hosted mobile and desktop Cash register and money management for your small business. Made after years of experience in the art of selling home made books and drawings during events like Japan Expo. +![alt_text][screenshot_home] A Symfony project created on March 23, 2018. @@ -19,7 +20,7 @@ A Symfony project created on March 23, 2018. * all in a libre software in PHP/JS --- -## Install +## [Install](/docs/installation.md) Have a look at the [Docs to install](/docs/installation.md) your own Caisse. All documentation is in the "docs" folder. Made By Tykayn/CipherBliss under [AGPL Licence](LICENSE). @@ -27,10 +28,13 @@ Made By Tykayn/CipherBliss under [AGPL Licence](LICENSE). www.cipherbliss.com ## Where to find help -Join the discussion at the Matrix Channel of CipherBliss: #cipherbliss:matrix.org -[https://matrix.to/#/!jfoYESqTObXYlKAOVM:matrix.org?via=matrix.org](matrix) +Join the discussion at the Matrix Channel of CipherBliss: +[#cipherbliss:matrix.org](https://matrix.to/#/!jfoYESqTObXYlKAOVM:matrix.org?via=matrix.org) +Or contact the Author: +[Contact Choices here](https://www.cipherbliss.com/contact) [logo]: https://www.cipherbliss.com/wp-content/uploads/2016/12/rond.png "Logo of CipherBliss company" +[screenshot_home]: https://www.cipherbliss.com/wp-content/uploads/2018/09/caisse_bliss_descritpion_open_source_cipherbliss-1260x709.png "Screenshot of Caisse Bliss" diff --git a/docs/installation.md b/docs/installation.md index 0c6ab497..97ce66f2 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,15 +1,26 @@ # Requirements: a web server speaking PHP, composer and NPM to install dependencies. +I develop on Ubuntu, so here are the steps i recommend: + +## Install [Composer](https://getcomposer.org/download/) via PHP command +``` +php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');" +php -r "if (hash_file('sha384', 'composer-setup.php') === '48e3236262b34d30969dca3c37281b3b4bbe3221bda826ac6a9a62d6444cdb0dcd0615698a5cbe587c3f0fe57a54d8f5') { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;" +php composer-setup.php +php -r "unlink('composer-setup.php');" +``` # Installation: -install dependencies: +install dependencies with [the bash script](/install.sh): ```bash bash install.sh ``` -edit parameters.yml to link to your mysql server -update schema with doctrine +## Configure your app parameters +In the [paramters.yml](/app/config/parameters.yml) file, setup your database access. Works with mysql and others via the magic of Doctrine ORM. + +update schema with doctrine in the command line. ```bash php bin/console doctrine:schema:update --dump-sql php bin/console doctrine:schema:update --force diff --git a/docs/upgrade.md b/docs/upgrade.md new file mode 100644 index 00000000..b57519b0 --- /dev/null +++ b/docs/upgrade.md @@ -0,0 +1,5 @@ +# Upgrade the app + +Pull the last news, and update the vendors. Update database, Rebuild the front, and that's it. +All of this is done with the `bash update.sh` script. +No need to reboot anything.