37 lines
1.8 KiB
Markdown
37 lines
1.8 KiB
Markdown
# Sakura
|
|
|
|
|
|
## Requirements
|
|
- PHP 7.1 or an equivalent environment
|
|
- MySQL 5.7 is recommended, you can use any database engine compatible with [illuminate/database](https://github.com/illuminate/database/tree/5.2) in theory though.
|
|
- [Composer](https://getcomposer.org/)
|
|
- [node.js](https://nodejs.org/) (for the typescript and less compilers)
|
|
- [Yarn](https://yarnpkg.com/) because npm is trash
|
|
|
|
Also as a sidenote, I highly recommend only running Sakura with x64 PHP.
|
|
|
|
## Installing
|
|
### Backend
|
|
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.
|
|
```
|
|
composer install
|
|
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.
|
|
|
|
### Frontend
|
|
To compile the LESS and TypeScript assets you need to have the individual compilers installed, both are available through yarn and can be installed with the following command:
|
|
```
|
|
yarn global add less typescript
|
|
```
|
|
After that install the required libraries by running `yarn` and from then on to compile the files you need to run `build.sh`.
|
|
|
|
If your editor yells at you that it can't find certain namespaces try running `build.sh` since that generates the required typings (.d.ts files).
|
|
|
|
## 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.
|