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

47 lines
2 KiB
Markdown
Raw Normal View History

2015-04-06 14:26:30 +00:00
# Sakura
2019-03-03 01:56:07 +00:00
2015-2017 source code of Flashii, once again open source
Has been superseded by [Misuzu](https://github.com/flashwave/misuzu)
<details><summary>Original README</summary>
2016-03-11 19:26:54 +00:00
![StyleCI](https://styleci.io/repos/45261697/shield)
2015-04-06 14:26:30 +00:00
2016-03-11 19:26:54 +00:00
## Requirements
2016-12-04 14:26:48 +00:00
- 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.
2016-11-01 17:00:42 +00:00
- [Composer](https://getcomposer.org/)
2016-12-04 14:26:48 +00:00
- [node.js](https://nodejs.org/) (for the typescript and less compilers)
- [Yarn](https://yarnpkg.com/) because npm is trash
2016-03-11 19:26:54 +00:00
2016-12-11 17:48:29 +00:00
Also as a sidenote, I highly recommend only running Sakura with x64 PHP.
2016-11-01 17:00:42 +00:00
## Installing
### Backend
2016-07-30 13:48:09 +00:00
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.
```
2016-11-01 17:00:42 +00:00
composer install
2016-07-30 13:48:09 +00:00
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-11-01 17:00:42 +00:00
### Frontend
2016-12-04 14:26:48 +00:00
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:
2016-11-01 17:00:42 +00:00
```
2016-12-04 14:26:48 +00:00
yarn global add less typescript
2016-11-01 17:00:42 +00:00
```
2016-12-04 14:26:48 +00:00
After that install the required libraries by running `yarn` and from then on to compile the files you need to run `build.sh`.
2016-03-11 19:26:54 +00:00
2016-11-01 17:00:42 +00:00
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
2016-03-11 19:26:54 +00:00
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
2016-11-01 17:00:42 +00:00
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.
2019-03-03 01:56:07 +00:00
</details>