- Webserver (Apache, Nginx, LiteSpeed, IIS, etc.) with PHP 8.2 or higher and MySQL 8.0 (or MariaDB 10.0) as database.
This project expects you to have local webserver and a locally installed MySQL/MariaDB instance. Alternatively there is full support for Docker, see Setup of your dev environment for more detailed information.
-
Launch a terminal or console and navigate to the webroot folder. Clone this repository from GitHub to a folder in the webroot of your server, e.g.
~/webroot/cois-hub
.$ cd ~/webroot $ git clone https://github.com/nplhse/cois-hub.git
-
Install the project with all dependencies by using make. Please note that if you want to use the development environment you have to use
make setup-dev
instead.$ cd ~/webroot/cois-hub $ make setup
-
You are ready to go, just open the site with your favorite browser!
This project includes full support for Docker which mainly includes the database, and we recommend using the
Symfony binary. There is a make start
command that builds the containers
und starts them in detached mode. More about the make
setup can be found in the CONTRIBUTING file
at available make commands.
Any contribution to this project is appreciated, whether it is related to fixing bugs, suggestions or improvements. Feel free to take your part in the development of this project!
However, you should follow some simple guidelines which you can find in the CONTRIBUTING file. Also, you must agree to the Code of Conduct.
See LICENSE.