Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tristandunn/untitled
A base Rails application to kickstart new projects.
https://github.com/tristandunn/untitled
brakeman cd ci github-actions hotwire kamal mocha rails rspec rubocop ruby stimulusjs tailwindcss template turbo turbo-rails
Last synced: about 1 month ago
JSON representation
A base Rails application to kickstart new projects.
- Host: GitHub
- URL: https://github.com/tristandunn/untitled
- Owner: tristandunn
- License: mit
- Created: 2020-04-11T22:15:29.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-16T19:47:59.000Z (about 1 month ago)
- Last Synced: 2024-11-16T20:21:08.879Z (about 1 month ago)
- Topics: brakeman, cd, ci, github-actions, hotwire, kamal, mocha, rails, rspec, rubocop, ruby, stimulusjs, tailwindcss, template, turbo, turbo-rails
- Language: Ruby
- Homepage:
- Size: 11.6 MB
- Stars: 3
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Untitled 
A base Rails application to kickstart new projects.
## Features
* Ruby [tests](spec/) using [RSpec](spec/spec_helper.rb) and
[Selenium](spec/support/capybara.rb) with
[coverage](spec/spec_helper.rb#L3-L14).
* JavaScript [tests](spec/javascripts) using
[Mocha](spec/javascripts/.mocharc.json) with coverage from [c8][].
* [Litestream](config/litestream.yml) database replication for backups.
* GitHub Actions for [testing, linting, security](.github/workflows/ci.yml), and
[continuous deployment](.github/workflows/cd.yml).
* [Kamal][] for deployments in [staging](config/deploy.yml) and
[production](config/deploy.production.yml), with
[customizable health checks](app/controllers/health_controller.rb).
* CSS using Tailwind CSS [configuration](config/tailwind.config.js).
## Development
Install the dependencies and setup the database.
```
bin/setup
```
To run the application processes.
```
bin/dev
```
If you're making changes, be sure to write and run the tests.
```
bundle exec rake ruby:test
bundle exec rake javascript:test
```
Before pushing changes, check the code.
```
bundle exec rake css:lint
bundle exec rake erb:lint
bundle exec rake ruby:lint
bundle exec rake javascript:lint
```
Or you can run the tests with coverage and lint with a single command.
```
bundle exec rake check
```
### Docker
Build the image with Docker.
```
docker build -t untitled .
```
Run the server using the image.
```
docker run --rm -p 3000:80 -e SECRET_KEY_BASE=$(bin/rails secret) --name untitled untitled
```
## License
Untitled uses the MIT license. See [LICENSE](LICENSE) for more details.
[Kamal]: https://kamal-deploy.org
[c8]: https://www.npmjs.com/package/c8