| .kamal | ||
| app | ||
| bin | ||
| config | ||
| db | ||
| lib/tasks | ||
| log | ||
| public | ||
| script | ||
| storage | ||
| test | ||
| tmp | ||
| vendor | ||
| .dockerignore | ||
| .gitattributes | ||
| .gitignore | ||
| .rubocop.yml | ||
| .ruby-version | ||
| config.ru | ||
| Dockerfile | ||
| Gemfile | ||
| Gemfile.lock | ||
| LICENSE | ||
| Procfile.dev | ||
| Rakefile | ||
| README.md | ||
Kommunify Platform
Kommunify Platform is a software template packed with useful gems and configurations.
At Kommunify we use it to build our own projects and get started quickly, and you're welcome to use it for yours.
This project template uses the Ruby on Rails (v8) framework and promotes the use of SQLite3 as the database.
Given the technical stack, Kommunify Platform is focused on providing a solid foundation for applications deployed as
small to medium-sized instances.
Warning
This project is still under active development and at a very early stage.
There is no guarantee that everything will work as intended, and breaking changes in the future are likely.
Features
- Branding and Styles
- PublicID Generation
- Localisation using I18n
- Authentication using Devise
- Authorization using Pundit
- Notifications using Noticed
- Auditing using PaperTrail
- CI/CD using Forgejo Actions
- Deployment using Kamal
Prerequisites
- Ruby 3.4.7
- Rails 8.0.4
Getting Started
- Clone the repository and run
bundle installto install the dependencies. - Set up the database with
rails db:setup. - Spin up the development server by running
bin/dev
Contributing
At the moment, we are not accepting contributions. If you have any questions or think you found a bug, feel free to reach out to us via email or just open an issue.