mintbooru/README.md

41 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2021-09-13 21:56:55 +00:00
# mintbooru
An imageboard that's a little more social.
## Requirements
2021-09-14 11:52:55 +00:00
- Ruby 2.7.3
- Node.js 14.x
- Java 11
- PostgreSQL 12
2021-09-13 21:56:55 +00:00
## Information about application structure
2021-09-14 11:52:55 +00:00
- mintbooru runs on the main branch of Rails to get the newest features,
so please keep that in mind. We are unapologetically modern in our backend,
and we don't apologize for it.
2021-09-13 21:56:55 +00:00
2021-09-14 11:52:55 +00:00
- We use a combination of tools to make this app work. We use the
[YUI Compressor](https://yui.github.io/yuicompressor/) to compress CSS
(mainly because Luna wanted to mess around with it for shits and giggles),
and we use the Terser gem to compress JS.
2021-09-13 21:56:55 +00:00
2021-09-14 11:52:55 +00:00
- JS is compiled using Webpack, and is included in the Sprockets build process.
2021-09-13 21:56:55 +00:00
2021-09-14 11:52:55 +00:00
- User authentication is implemented through
[Devise](https://github.com/heartcombo/devise), and is modified as needed.
2021-09-13 21:56:55 +00:00
## Credits
2021-09-14 11:52:55 +00:00
- [Luna](https://luna.mint.lgbt) - Main developer
2021-09-13 21:56:55 +00:00
2021-09-14 11:52:55 +00:00
- [mint](https://they.mint.lgbt) - Developer
- [Erin](https://the-system.eu.org) - For being with me in my darkest times
2021-09-13 21:56:55 +00:00
## License
As I want this to be as accessible as possible, mintbooru is licensed under the
[Apache 2.0](COPYING) license. This allows you to do almost anything with the application,
but not use our branding in your app.