diff --git a/README.md b/README.md index cba73e0..8220daf 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Programvareverkstedet nettside +# Programvareverkstedets nettside A website created with the latest and greatest web technologies. May contain blackjack and other things one tends to include in awesome projects. @@ -11,30 +11,40 @@ Put it in a folder your webserver can find. ## Development setup -Make sure you have sqlite3 and PHP installed, with pdo-sqlite module. +Make sure you have `sqlite3`, `php` and `pdo-sqlite` installed. These can be obtained from your package manager. +Then make sure PHP has the `curl`, `pdo-sqlite` and `sqlite3` extensions enabled, see `/etc/php/php.ini`. ./dev.sh -On Windows, you have to perform a `composer install` manually beforehand. Make sure you have PHP and sqlite3 available in path: +On Windows you can use chocolatey and git bash to run `./dev.sh`. +Install `php` and `sqlite`, then enable these extensions in `C:\tools\php80\php.ini`: +`mbstring`, `openssl`, `curl`, `pdo-sqlite` and `sqlite3` + +Alternatively you may use `cmd` on Windows. +In this case you'll have to perform a `composer install` manually beforehand. +Good luck. dev.bat + ### Dependency management -`dev.sh` will ensure the git submodules have been pulled, then download the `composer` package manager to the php archive file `composer.phar` and run it. -Composer will check for the php extension `pdo_sqlite` which must be enabled on your system. This usually includes installing a php-sqlite3 package and enabling it in `/etc/php/php.ini`: +`dev.sh` will ensure the git submodules have been properly pulled, then download the `composer` package manager to a php archive file named `composer.phar`, then run it. +Composer will then check for the php extensions needed, such as `pdo_sqlite`, which must be enabled on your system. +This usually includes installing a php-sqlite3 package and enabling it in `/etc/php/php.ini`: [PHP] extension=pdo_sqlite extension=sqlite3 - extension=ext-curl + extension=ext-curl Composer is used as such: php composer.phar update php composer.phar install + ### Docker We provide a simple docker-compose setup for local development. @@ -50,18 +60,18 @@ then ### Admin account Login goes through `idp.pvv.ntnu.no` via SAML, so you have to use your PVV account. -(This only works if you use the hostname `localhost`) -To make your account into an admin accout, run: +(This only works if you use access the local development site via the the hostname `localhost`) +To make your account into an admin account, run: - sqlite3 pvv.sqlite 'INSERT INTO users (uname, groups) VALUES ("your_username", 1);' + sqlite3 pvv.sqlite 'INSERT INTO users (uname, groups) VALUES ("YOUR_USERNAME", 1);' -If using docker, when running: +If using docker, when already running: - DOCKER_USER=$(id -u):$(id -g) docker-compose exec nettside sqlite3 pvv.sqlite 'INSERT INTO users (uname, groups) VALUES ("your_username", 1);' + DOCKER_USER=$(id -u):$(id -g) docker-compose exec nettside sqlite3 pvv.sqlite 'INSERT INTO users (uname, groups) VALUES ("YOUR_USERNAME", 1);' If not already running: - DOCKER_USER=$(id -u):$(id -g) docker-compose run nettside sqlite3 pvv.sqlite 'INSERT INTO users (uname, groups) VALUES ("your_username", 1);' + DOCKER_USER=$(id -u):$(id -g) docker-compose run nettside sqlite3 pvv.sqlite 'INSERT INTO users (uname, groups) VALUES ("YOUR_USERNAME", 1);' ## Hosting