diff --git a/README.md b/README.md index b1bd5877..3a1f4f38 100755 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ A Symfony project created on March 23, 2018. ## Features: * live selling and stock update on phone and desktop +* multi user registration * managing products, categories * forecast of expenses * events @@ -22,10 +23,16 @@ A Symfony project created on March 23, 2018. --- ## [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). - -www.cipherbliss.com +## News +Ipublish news about this app here: +https://www.cipherbliss.com + +So here is a tag: https://www.cipherbliss.com/tag/caisse/ + +You can follow the website with RSS/atom feeds. +https://www.cipherbliss.com/feed/ + ## Where to find help Join the discussion at the Matrix Channel of CipherBliss: @@ -37,4 +44,5 @@ Or contact the Author: [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" - +Hosted on Framagit.org +https://framagit.org/tykayn/caisse-bliss.git diff --git a/docs/installation.md b/docs/installation.md index 97ce66f2..27489b6c 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,24 +1,35 @@ # Requirements: a web server speaking PHP, composer and NPM to install dependencies. -I develop on Ubuntu, so here are the steps i recommend: +I develop on [Ubuntu](https://ubuntu.org), so here are the steps i recommend: ## Install [Composer](https://getcomposer.org/download/) via PHP command +Composer manages dependencies of a lot of php projects. Try these commands or refer to [the download docs of getcomposer.org](https://getcomposer.org/download/) ``` 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');" + +composer install ``` # Installation: -install dependencies with [the bash script](/install.sh): +When you have satisfied all the previous requirements you can install dependencies with [the bash script](/install.sh): ```bash bash install.sh ``` ## 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. +In the [paramters.yml](/app/config/parameters.yml) file, setup your database access (create your DB if necessary). Works with mysql and others via the magic of Doctrine ORM. + +```yaml + database_host: 127.0.0.1 + database_port: null + database_name: symfony + database_user: YOURDATABASEUSER + database_password: YOURDATABASEPASSWORD +``` update schema with doctrine in the command line. ```bash @@ -36,3 +47,6 @@ php bin/console server:run firefox http://http://127.0.0.1:8000/ ``` enjoy! + +#install via Docker ? +I didn't do that for the moment, but you can contribute to this if you like to.