https://github.com/andrewmcodes-archive/thrusters
Opinionated Rails app bootstrapper
https://github.com/andrewmcodes-archive/thrusters
Last synced: 3 months ago
JSON representation
Opinionated Rails app bootstrapper
- Host: GitHub
- URL: https://github.com/andrewmcodes-archive/thrusters
- Owner: andrewmcodes-archive
- License: mit
- Created: 2019-03-02T07:57:21.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-31T05:07:15.000Z (about 6 years ago)
- Last Synced: 2025-01-01T06:22:12.496Z (5 months ago)
- Language: Ruby
- Size: 73.2 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Thrusters
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fandrewmcodes%2Fthrusters?ref=badge_shield)
Thrusters is an opinionated Rails app bootstrapper.
**Rails Version**: 5.2
**Ruby Version**: 2.6.2
## Getting Started
### Common errors
If you get an error that starts with `NameError: uninitialized constant MyAppName::Application::MyApplication` then check line 13 of `config/application.rb`. This issue is mitigated if you name your app `MyNewApp` vs `my-new-app` or `my_new_app`.
These are known bugs and are being worked on!
### Requirements
You'll need the following installed to run the template successfully:
* Ruby 2.6.2
* Editable via `.ruby-version` file
* Bundler
* `gem install bundler`
* Rails
* `gem install rails`
* Yarn
* `brew install yarn`
* Redis
* `brew install redis`
* Foreman (optional)
* `gem install foreman`
### Creating a new app
```bash
rails new myapp -d postgresql -m https://raw.githubusercontent.com/andrewmcodes/thrusters/master/template.rb
```
Or if you have downloaded this repo, you can reference template.rb locally:
```bash
rails new myapp -d postgresql -m template.rb
```
To run your app, use `foreman start`.
This will run `Procfile.dev` via `foreman start -f Procfile.dev` as configured by the `.foreman` file and will launch the development processes `rails server`, `sidekiq`, and `webpack-dev-server` processes. You can also run them in separate terminals manually if you prefer.
A separate `Procfile` is generated for deploying to production.
If all goes well, your app will be running on `localhost:5000`.
### Authenticate with social networks
We use the encrypted Rails Credentials for app_id and app_secrets when it comes to omniauth authentication. Edit them as so:
```
EDITOR=code rails credentials:edit
```
Make sure your file follow this structure:
```yml
secret_key_base: [your-key]
development:
github:
app_id: something
app_secret: something
options:
scope: 'user:email'
whatever: true
production:
github:
app_id: something
app_secret: something
options:
scope: 'user:email'
whatever: true
```
With the environment, the service and the app_id/app_secret. If this is done correctly, you should see login links
for the services you have added to the encrypted credentials using `EDITOR=code rails credentials:edit`
### Cleaning up
```bash
rails db:drop
spring stop
cd ..
rm -rf myapp
```
## Contributing
[Contributing Guide](/CONTRIBUTING.md)
## Code of Conduct
[Code of Conduct](/CODE_OF_CONDUCT.md)
## License
[MIT](/LICENSE.md)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fandrewmcodes%2Fthrusters?ref=badge_large)
## Recognition
This project was originally forked from [excid3/jumpstart](https://github.com/excid3/jumpstart). Many thanks to [Chris Oliver](https://github.com/excid3) for creating this awesome project.