https://github.com/wscourge/edoctfad
Recruitment task for Daftcode
https://github.com/wscourge/edoctfad
rspec ruby ruby-on-rails ruby-on-rails-6
Last synced: 2 months ago
JSON representation
Recruitment task for Daftcode
- Host: GitHub
- URL: https://github.com/wscourge/edoctfad
- Owner: wscourge
- Created: 2020-03-01T14:02:00.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2020-03-22T19:16:57.000Z (over 6 years ago)
- Last Synced: 2025-07-03T08:45:15.434Z (about 1 year ago)
- Topics: rspec, ruby, ruby-on-rails, ruby-on-rails-6
- Language: Ruby
- Homepage: https://daftcode.com
- Size: 34.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Edoctfad
Ruby on Rails application initialized with [Hix on Rails][hixonrails].
## System dependencies
- Ruby version: 2.7.0
- Rails version: 6.0.2.1
- Database: PostgreSQL
## Configuration
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 is your
credentials for your local SQL database.
Then, install all the necessary gems:
```bash
bundle 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
After completing all the steps above, start the project with:
```bash
rails server
```
## How to run the test suite
First, copy (and optionally cusotmize) the RSpec configuration file:
```bash
cp .rspec.sample .rspec
```
In order to run the whole test suite, run:
```bash
$ bundle exec rspec
```
## Code quality checks
The application provides the following code quality analysis tools:
- [Brakeman][brakeman]
- [Fasterer][fasterer]
- [RuboCop][rubocop] with [RuboCop RSpec][rubocop-rspec], [RuboCop Performance][rubocop-performance] and [RuboCop Rails][rubocop-rails]
- [Rails Best Practices][rails-best-practices]
- [Bundler Audit][bundler-audit]
To run them locally:
```bash
$ bundle exec brakeman
$ bundle exec fasterer
$ bundle exec rubocop
$ bundle exec rails_best_practices
$ bundle audit
```
[hixonrails]: https://hixonrails.com
[brakeman]: https://github.com/presidentbeef/brakeman
[rubocop]: https://github.com/rubocop-hq/rubocop
[rubocop-performance]: https://github.com/rubocop-hq/rubocop-performance
[rubocop-rspec]: https://github.com/rubocop-hq/rubocop-rspec
[rubocop-rails]: https://github.com/rubocop-hq/rubocop-rails
[fasterer]: https://github.com/DamirSvrtan/fasterer
[rails-best-practices]: https://github.com/flyerhzm/rails_best_practices
[bundler-audit]: https://github.com/rubysec/bundler-audit