Add new REST ressources.

[Project_proches_de_moi-server.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..0a3e81e
--- /dev/null
+++ b/README
@@ -0,0 +1,64 @@
+* Installation:
+---------------
+
+    * Symfony:
+
+We suppose the Symfony framework is already installed with the composer.
+
+$ git clone https://git.piment-noir.org/Project_proches_de_moi-server.git /path/to/apache_document_root
+$ cd /path/to/apache_document_root
+$ composer install
+$ cp .env.dist .env
+$ vi .env
+    edit the line
+        DATABASE_URL=mysql://db_user:db_password@127.0.0.1:3306/db_name
+    to make it match your database installation
+$ php/console bin/console doctrine:database:create
+
+    * Apache:
+
+Virtual localhost configuration:
+
+<VirtualHost *:80>
+    ServerName domain.tld
+
+    DocumentRoot /path/to/apache_document_root/public
+    <Directory /path/to/apache_document_root/public>
+        AllowOverride None
+        Order Allow,Deny
+        Allow from All
+
+        <IfModule mod_rewrite.c>
+            Options -MultiViews
+            RewriteEngine On
+            RewriteCond %{REQUEST_FILENAME} !-f
+            RewriteRule ^(.*)$ index.php [QSA,L]
+        </IfModule>
+    </Directory>
+
+    # uncomment the following lines if you install assets as symlinks
+    # or run into problems when compiling LESS/Sass/CoffeeScript assets
+    # <Directory /path/to/apache_document_root>
+    #     Options FollowSymlinks
+    # </Directory>
+
+    # optionally disable the RewriteEngine for the asset directories
+    # which will allow apache to simply reply with a 404 when files are
+    # not found instead of passing the request into the full symfony stack
+    <Directory /path/to/apache_document_root/public/bundles>
+        <IfModule mod_rewrite.c>
+            RewriteEngine Off
+        </IfModule>
+    </Directory>
+    ErrorLog ${APACHE_LOG_DIR}/domain.tld_error.log
+    CustomLog ${APACHE_LOG_DIR}/domain.tld_access.log combined
+
+    # optionally set the value of the environment variables used in the application
+    #SetEnv APP_ENV prod
+    #SetEnv APP_SECRET <app-secret-id>
+    #SetEnv DATABASE_URL "mysql://db_user:db_pass@host:3306/db_name"
+</VirtualHost>
+
+    * REST resources:
+
+Open the tests/curl.txt file for an overview.