This software is licensed under the MIT license. The fonts included in this source tree (`frontend/public/assets/woff2`) and the Iosevka build plans (`frontend/webfonts/iosevka/private-build-plans.toml`) are licensed under the SIL Open Font License 1.1. Please visit https://github.com/be5invis/Iosevka/blob/master/LICENSE.md for more information.
If you plan on self-hosting Waffle, it's recommended to use Docker and docker-compose like shown below. This isn't recommended if you plan on developing Waffle. The guide below assumes you have `git` installed on your system (on Debian/Ubuntu: `sudo apt install git`):
1. [Install Docker using the official guide](https://docs.docker.com/engine/install/)
2. [Install docker-compose using the official guide](https://docs.docker.com/compose/install/)
3. Clone the Waffle repository: `git clone https://git.hippoz.xyz/hippoz/waffle`
4. Enter the repository's directory: `cd waffle`
5.**Optionally,** you can open up `docker-compose.yml` in your text editor to change options like the port. The default port is `5002`.
6. Start the stack: `docker-compose up -d`
7. All done! 🎉 Waffle is now running on port `5002`.
