Files
isdefoobaropen/README.md

42 lines
993 B
Markdown

# Is de FooBar open?
Source code for the unofficial FooBar website.
## Building
This project requires both `composer` and `yarn` (`npm` might work as a
replacement) to build.
```bash
composer update --no-dev
yarn
yarn run webpack --mode production
```
This will download all dependencies and compile javascript as needed.
For development, you can run the following:
```bash
composer update
yarn
yarn watch &
yarn serve
```
when you do, a PHP built-in web server will launch.
## Installation
After building, you can install the project on your web server by copying
everything (except for the `node_modules`) to your server. The document root
should be `public`.
## Configuration
The website will attempt to load configuration from `config/config.php` and
if that doesn't work, from `config/config.sample.php`. You can create your own
configuration by copying the sample and changing parameters as needed.
The sample configuration also contains details on the particular options.