Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shey/railcar
Quickstart Rails 7 App to use with Railroad
https://github.com/shey/railcar
rails
Last synced: 3 months ago
JSON representation
Quickstart Rails 7 App to use with Railroad
- Host: GitHub
- URL: https://github.com/shey/railcar
- Owner: shey
- License: mit
- Created: 2023-07-18T20:26:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-24T05:54:18.000Z (about 1 year ago)
- Last Synced: 2024-10-10T20:45:25.966Z (3 months ago)
- Topics: rails
- Language: Ruby
- Homepage:
- Size: 46.9 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Railcar
Welcome to Railcar, a quick-start Rails 7 solution, specifically designed to work with the Railroad server configuration.
Railcar is a fully setup Rails 7.0.8 application and the the companion to the Railroad Ansible project. It provides you with a Docker-free setup to kickstart your Rails application development.
### Key Features
* Rails 7.0.8
* Tailwind CSS
* Authentication with Devise 4.9
* Deployment ready with Capistrano
* Postgresql
* Unicorn
* Ruby 3.1.2
## Getting Started
To get started with Railcar:
Download or clone both the [Railcar](https://github.com/shey/railcar/) and [Railroad](https://github.com/shey/railroad) repositories.
1. Set up your Ubuntu server using the Railroad Ansible project to ensure compatibility.
1. In the Railcar repository, navigate to `config/deploy/production.rb` and update it with your server's IP address.
1. In the deployment script, `config/deploy.rb`, update the `repo_url` with the URL to your repo.
## Environment Variables
In Railcar, environment variables are handled by Railroad. It's worth noting that Railcar does not use Rails' built-in `credentials.yml` file for environment management. Ensure that your copy of the Railroad repo has env vars defined in and copied over to the `.env` file on the remote host.
## Deploying
#### Make ssh-agent happy
```sh
pkill ssh-agent && eval `ssh-agent` && ssh-add ~/.ssh/id_rsa
```
#### Confirm access to git
SSH into your server, `ssh [email protected]`, and run `ssh -T [email protected]` to ensure your keys are forwarded to Github.
#### First-time Deploy
From the root of the app, first run `bundle exec cap production deploy:setup` to setup the directories on the remote host, and then run `bundle exec cap production deploy` to deploy the app.
#### Subsequent Deploys
From the root of the app run `bundle exec cap production deploy` or use the helper `make deploy`. By default `capistrano` will deploy the `main` branch from your git repo.
## License
Railcar is open-source software, licensed under [The MIT License](LICENSE).
## Support
For support and additional queries, please contact [email protected].
Note: Railcar is designed to be used in conjunction with the Railroad Ansible project. For optimal results, deploy Railcar to a server configured using Railroad.