This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
-
Ruby version
-
System dependencies
-
Configuration
-
Database creation
-
Database initialization
-
How to run the test suite
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
...
"Rails Engine Lite" is an API for a fabricated eCommerce site. Full functionality can be found in the "API" section below.
There are 6 tables with 5 one-to-many relationships:
- Rails 6.1.4.1
- Ruby 2.7.2
- PostgreSQL
- Factory Bot
- Faker
- jsonapi serializer
- rspec
- From the command line, install gems and set up your DB:
bundle
rails db:{create, migrate, seed}
- Run the test suite with
bundle exec rspec
.
This API has multiple endpoints returning:
- All merchants
- All items
- Instances of merchants & items
- Full CRUD functionality for above
- Keyword searches for above