NoelLincoln / hello-rails-back-end

Ruby on rails API for generating a random greeting which will be fetched and displayed by a react frontend

Hello Rails Back-End

📗 Table of Contents

• 📗 Table of Contents
• About the Project
• 🛠 Project Requirements
  • 👋 Hello Rails Front-End
  • 💻 API Endpoints
  • 🚀 Getting Started
    • Prerequisites
    • Setup
    • Run the Project
  • 👥 Author
  • 🔭 Issues
  • 🤝 Contributing
  • ⭐️ Show Your Support
  • 📝 License

👋 Hello Rails Back-End

This project is a Rails API application that provides a server API for the [Hello Rails Front-End]. The API provides a single endpoint that returns a random greeting from the database.

🛠 Project Requirements

• Create a Rails API app called 'hello-rails-back-end'.
• Initialize the project with Git.
• Set up a Postgres database and create a table for storing messages.
• Populate the table with 5 different greetings.
• Create an API endpoint that selects a random greeting from the table.

🔗 Integration with Hello Rails Front-End

Here is the link to the Hello Rails Front-Endrepository.

(back to top)

Key Features

• Ruby on Rails framework
• Use Linters to check code quality
  • Rubocop
• MVC architectural/design pattern
• Data persistent in PostgreSQL
• RESTful API

(back to top)

💻 API Endpoints

• GET /api/v2/greetings/random
  • Returns a random greeting from the database.

(back to top)

🚀 Getting Started

To get the project up and running on your local machine, follow these steps.

Prerequisites

Before you begin, make sure you have the following prerequisites installed on your system:

• Ruby: You need Ruby to run the Rails application.
• Bundler: Bundler is used to manage gem dependencies in your Ruby project.
• Postgres: You need Postgres as the database for the Rails app.

Setup

Clone this repository to your desired folder:

git clone https://github.com/NoelLincoln/hello-rails-back-end.git
cd hello-rails-back-end

Install gem dependencies:

bundle install

Set up the database:

rails db:create
rails db:migrate
rails db:seed

Run the Project

To run the project, execute the following command:

rails server

The API will be accessible at ``.

(back to top)

👥 Author

👤 Noel Bryant

• GitHub: @NoelLincoln
• Twitter: @Noel_Lincoln

(back to top)

🔭 Future Features

Upcoming improvements:

• Add the endpoints to create, update and delete a greeting
• Deploy the application

(back to top)

🔭 Issues

Find a bug or have a feature request? Open a new issue here on GitHub.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

(back to top)

⭐️ Show Your Support

If you find this project helpful, please consider starring the repository. Your support is greatly appreciated!

(back to top)

📝 License

This project is MIT licensed.

(back to top)