License & readme

This commit is contained in:
Mael G. 2019-07-29 15:08:55 -04:00
parent 0a3c359cbf
commit 779718fcf7
2 changed files with 71 additions and 0 deletions

7
LICENSE Normal file
View file

@ -0,0 +1,7 @@
Copyright 2019 Maël G.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

64
README.md Normal file
View file

@ -0,0 +1,64 @@
# Gnous.eu
![https://git.gnous.eu/gnouseu/gnousdoteu/raw/branch/master/public/img/gnous.png](https://git.gnous.eu/gnouseu/gnousdoteu/raw/branch/master/public/img/gnous.png) [![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com) https://forthebadge.com/images/badges/gluten-free.svg
Main website of [Gnous.eu](https://gnous.eu/?lang=en), the French speaking community of free software enthusiasts since 2017.
This website use Smarty template engine and Spectre CSS framework.
This project is **stable** and is already in production.
## Deployment
### Requirements :
To deploy this website you need :
1. PHP7.1 or higher
2. Composer (only for **developpement**)
3. A webserver (NGINX is recommanded)
4. At least 1.5 Gb of hard drive
5. modrewrite and .htaccess enabled (in the case of apache)
6. Git
### Installation :
* Clone the Git repository :
``git clone https://git.gnous.eu/gnouseu/gnousdoteu``
* Make our webserver pointing to ``public`` folder. The main folder should'nt be accessible.
* Allow ``/public/index.php`` to write ``/public/templates_c``.
* Make our webserver serve ``/public/index.php`` for all pages **and conserving args** :
eg for NGINX (in ``server{``) :
```
location / {
try_files $uri $uri/ /index.php?$args;
}
```
* Make our webserver serve it for 404 and 403 too :
eg for NGINX (in ``server{``) :
```
error_page 404 /index.php;
error_page 403 /index.php;
```
* If you use modpagespeed, disable it for ``/img/gnous.svg``:
eg for NGINX-modpagespeed (in ``server{``) :
```
pagespeed Disallow "*/img/gnous.svg";
```
* Reload your webserver and check if all is working
### License :
This project is under [MIT license](LICENSE)