https://github.com/andrewmcodes-archive/gitpod_rails_starter
https://github.com/andrewmcodes-archive/gitpod_rails_starter
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/andrewmcodes-archive/gitpod_rails_starter
- Owner: andrewmcodes-archive
- License: mit
- Created: 2020-07-22T03:04:52.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2020-07-22T07:33:02.000Z (almost 5 years ago)
- Last Synced: 2025-01-01T06:22:25.622Z (5 months ago)
- Language: Ruby
- Size: 272 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](CONTRIBUTING.md)
# WIP: Gitpod Rails Starter
[](https://gitpod.io/#https://github.com/andrewmcodes/gitpod_rails_starter)
## Setup
Please take note that we are using `main` as the base branch.
### System dependencies
- Ruby version: 2.7.1
- Rails version: 6.0.3.1
- Database: PostgreSQL
- Redis installed
### Configuration
#### Automated
```bash
bin/setup
```
#### Manually
```
Copy an existing sample environment file. Run:
```bash
$ cp .env.sample .env
```
and edit newly created `.env` file. The minimum you are going to need are
credentials to your local PostgreSQL database.
Then, install all the necessary dependencies:
```bash
bundle install && yarn install
```
### Database creation
In order to create the database with all the necessary seed data, run:
```bash
rails db:create db:schema:load db:seed
```
### How to start the app
Start the Ruby on Rails server with:
```bash
rails server
```
We __highly__ recommend running the weback dev server in another tab instead of inline compilation that will occur if you don't for speed.
```bash
bin/webpack-dev-server
```
To _optionally_ run Sidekiq, launch another process with:
```bash
bundle exec sidekiq
```
### Code quality checks
The application provides the following code quality analysis tools:
- [Brakeman][brakeman]
- [Fasterer][fasterer]
- [Rails Best Practices][rails-best-practices]
- [Bundler Audit][bundler-audit]
To run them locally:
```bash
$ bundle exec brakeman
$ bundle exec fasterer
$ bundle exec rails_best_practices
$ bundle audit
```
[brakeman]: https://github.com/presidentbeef/brakeman
[fasterer]: https://github.com/DamirSvrtan/fasterer
[rails-best-practices]: https://github.com/flyerhzm/rails_best_practices
[bundler-audit]: https://github.com/rubysec/bundler-audit
### Changelog
Coming Soon
### Contributing
Coming Soon
### Code of Conduct
[Code of Conduct][coc]
### License
[MIT][license]
[changelog]: /CHANGELOG.md
[coc]: /CODE_OF_CONDUCT.md
[contributing]: /CONTRIBUTING.md
[license]: /LICENSE