Public/pics
2
2
Fork 2
Code Issues 5 Pull Requests Releases Wiki Activity

Add readme and license files #24

Merged
Aaron merged 2 commits from readme into master 2020-12-30 20:09:06 +01:00
Conversation 1 Commits 2 Files Changed 3 +31 -1
2 changed files with 31 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 936d3d20db - Show all commits

1
README
View File

@ -1 +0,0 @@
This marks the development repository for the HashRU website.

31
README.md Normal file
View File

@ -0,0 +1,31 @@
# HashRU Pics
This is the development repository for the HashRU photo website.
The CMS and its modules originate in [Kabuki CMS](https://aaronweb.net/projects/kabuki/), but have been extended and are maintained separately in this repository.
## Requirements
The Kabuki codebase requires the following PHP extensions to be enabled for full operation:
* exif
* imagick (PECL)
* mysqli
## Setup
Copy `config.php.dist` to `config.php` and set-up the constants contained in the file.
## Running
For development purposes, simply run the `server` script provided in the root of this repository.
This will start a PHP development server on `hashru.local:8080`.
For a production environment, please set up a proper PHP-FPM environment instead.
## Contributing
Pull requests are welcome over at the [HashRU Gitea](https://gitea.hashru.nl/Public/pics/pulls).
## License
The HashRU Pics repository is licensed with a BSD 3-clause license, as is Kabuki CMS.