Sajeelzafar / hello-rails-back-end

📗 Table of Contents

• 📗 Table of Contents
• Hello Rails
  • Built With
    • Tech Stack
    • Key Features
  • Getting Started
    • Prerequisites
    • Setup
    • Available Scripts
  • Author
  • Future Feature
  • Contributing
  • Show your support
  • Acknowledgments
  • License

Hello Rails

Hello Rails is a Ruby on Rails/React demo project that demonstrates the use of the 2 apps strategy where we split our app into 2 parts back-end and front-end, this repo represents the back-end part and is built with Rails.

you can find the front-end repository here

Built With

Tech Stack

• Ruby 3.1
• Ruby on Rails 7
• PostgreSQL 15

Key Features

• Provide a random message through the API endpoint

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Ruby
• Ruby on Rails
• any code editor

Setup

To setup the project follow the steps:

1. Clone this project using Git Bash:

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

2. Inside the project directory, install the project's dependencies

   bundle install
   

3. Setup the app's database

   rails db:setup
   

Available Scripts

In the project directory, you can run:

• rails server
  

  Runs the app server

• rubocop
  

  Launches the test runner.

Author

👤 Sajeel Zafar

• GitHub: @Sajeelzafar
• Twitter: @SajeelZafar6
• LinkedIn: Sajeel Zafar

Future Feature

• Coming soon!

Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

If you like this project give it a star!

Acknowledgments

• Microverse ❤️

License

This project is MIT licensed.