This repository has been archived on 2024-06-26. You can view files and clone it, but cannot push or open issues or pull requests.
sakura/README.md

32 lines
1.3 KiB
Markdown
Raw Normal View History

2015-04-06 14:26:30 +00:00
# Sakura
2016-03-11 19:26:54 +00:00
![StyleCI](https://styleci.io/repos/45261697/shield)
![SensioLabsInsight](https://insight.sensiolabs.com/projects/6c9b3813-0f50-406c-ab26-665e11876bc9/mini.png)
2015-04-06 14:26:30 +00:00
2016-03-11 19:26:54 +00:00
## Requirements
2016-03-27 22:15:51 +00:00
- PHP 7.0.0 or newer
- A database engine compatible with your PHP install and Laravel/Illuminate's database abstraction layer, MySQL 5.7 recommended.
2016-03-11 19:26:54 +00:00
2016-03-27 22:15:51 +00:00
I will include a full list of required extensions later.
2016-03-11 19:26:54 +00:00
2016-07-30 13:48:09 +00:00
## Development setup
Copy config.example.ini, set everything up to your liking (database is most important). I'd also recommend setting `show_errors` to `true` for development. Then run the following commands in the root.
```
php mahou database-install
php mahou database-migrate
php mahou setup
```
After that you can either use `php mahou serve` to use the built in development server or serve the public folder through your webserver of choice.
2016-03-11 19:26:54 +00:00
## Contributing
Right now I'm not accepting big PRs because of a set of big things not being fully implemented yet, bug fix PRs are more than welcome though!
## License
Sakura is licensed under the Apache License version 2. Check the [LICENSE file](https://github.com/flashwave/sakura/blob/master/LICENSE) for the full thing or if you just want a quick summary [click here](https://i.flash.moe/vlcsnap-2016-03-09-17h45m55s452.png).