dylan-perry / lunch_and_learn_be

Lunch and Learn

Introduction

Lunch and Learn is an educational API that provides recipes, historical videos, and other fun and useful information about various countries. It also features user CRUD functionality, the ability to favorite resources by user, and session CRUD and authentication functionality.

Installing Lunch and Learn API

To use the Lunch and Learn API, you will need the following:

• Ruby Version 3.x.x or higher
• A terminal application, such as Terminal (MacOS) or Windows Terminal (Windows)

Once these prerequisites are in place, please complete the following steps:

1. Clone down the lunch_and_learn_be repository to your local machine, using the green Code button.
2. Navigate to the lunch_and_learn_be repository with your Terminal application.
3. From the terminal application, run the command bundle install
4. In the same terminal session, run rails db:{drop,create,migrate}
5. In the same terminal session, run rails server

Congratulations! The Lunch and Learn API is now running on your local server, and is ready for use.

Using Lunch and Learn API

The Lunch and Learn API exposes the following endpoints for user consumption:

• User Endpoints
  • POST Create User
• Favorite Endpoints
  • GET All Favorites for User
  • POST Create Favorite for User
• Recipe Endpoints
  • GET All Recipes for Country
• Learning Resource Endpoints
  • GET All Learning Resources for Country
• Session Endpoints
  • POST Create Session for User

User Endpoints

POST /users — Create User

=

Expand

Creates a new user within the database, and returns a JSON response indicating either successful user creation, or unsuccessful user creation with errors.

Example Request:

POST localhost:3000/api/v1/users

Exmaple JSON Response:

{
    "success": "User created successfully!"
}

Favorite Endpoints

POST /favorites — Create User

=

Expand

Creates a new user favorite for a user, and returns a JSON response indicating either successful user creation, or unsuccessful user creation with errors.

Example Request:

POST localhost:3000/api/v1/users

Exmaple JSON Response:

{
    "success": "User created successfully!"
}