Rails Engine Lite

Rails Engine Lite is a project for an E-Commerce application that exposes data through an API that the front-end can consume. This project is designed to help practice skills such as API exposure, JSON formatting with serializers, and SQL/ActiveRecord querying.

Learning Goals

Explicit

Develop a functional understanding of exposing an API Become familiar with formatting JSON responses with serializers Gain experience testing an API Learn how to use SQL and ActiveRecord to gather data

Implicit

Improve ability to read documentation Practice time management and prioritizing work Enhance skills in breaking down large projects into smaller pieces Improve ability to break down problems into smaller steps Gain experience in individual research through articles, videos, and mentors Develop project management skills

Endpoints

This API provides various endpoints for merchants and items. Please refer to the API documentation for more information.

Setup

  1. Clone this repository
  2. Run bundle install
  3. Run rails db:create and rails db:migrate to create and migrate the database
  4. Run rails db:seed to seed the database with sample data
  5. Start the server with rails s

Future Updates

Possible future updates to this project include implementing additional endpoints and expanding the scope of the API. Suggestions for improvements or feature requests are welcome.

Contributors

This project was developed by Harrison Ryan. If you find any bugs or would like to make any improvements, feel free to submit a pull request or open an issue. For any inquiries or suggestions, please start a new discussion on this repo's home page.