This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
- Ruby version
2.7.2
- Rails version
5.2.6.2
- System dependencies
- Rails / Ruby / Postgresql
- install rbenv
$ brew install rbenv ruby-build
- Set up rbenv in your shell
$ rbenv init
- Close your terminal window and open a new one so your changes take effect
- Verify that rbenv is properly set up using the rbenv-doctor script:
curl -fsSL https://github.com/rbenv/rbenv-installer/raw/main/bin/rbenv-doctor | bash
- install ruby version 2.7.2
$ rbenv install 2.7.2
- install rails
$ gem install rails --version=5.2.6.2
- you may need to add this line to bottom of your zshrc or bashrc to run ruby commands
eval "$(rbenv init -)"
- How to run the test suite
$ bundle install
$ rails db:{drop,create}
- Run tests for requests
$ bundle exec rspec spec/requests
- Run tests for clients
$ bundle exec rspec spec/clients
- Run entire test suit
$ bundle exec rspec
- Deployment instructions run the rails server
$ rails s
open a web browser to http://localhost:3000 and go to the following end points
/api/ping
/api/posts/tags=<your_topic_goes_here> -> options params
sortBy=<your_attribute_to_sort_by> and direction=<desc> to order results in
descending order