README.md

📗 Table of Contents

• 📗 Table of Contents
• 📖 Hello Rails Backend
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Hello Rails Backend

Hello Rails Backend is an implemention of a connection between Ruby on Rails back-end and React front-end. Hello Rails Backend handles the backend API, and Hello React Frontend handles the frontend UI to display a random greeting message.

🛠 Built With

Tech Stack

Client

• Linters

Server

• ROR

Database

• PostgreSQL

Key Features

• Display a random greeting message

(back to top)

🚀 Live Demo

• N/A

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

• Ruby on Rails installed and running. To get more information, read the installation guide.

• PostgreSQL installed and running

Setup

Clone this repository to your desired folder:

  git clone git@github.com:KanzaTahreem/Hello-Rails-Backend.git
  cd Hello-Rails-Backend 

Install

Install thr project dependencies with:

  bundle install
  rails db:create
  rails db:migrate
  rails db:seed

Usage

To run the project, execute the following command:

  rails s

Run tests

To run all tests, including unit and integration tests, run the following command:

  rspec

Deployment

You can deploy this project using:

  N/A

(back to top)

👥 Author

👤 Kanza Tahreem

• GitHub: @KanzaTahreem
• Twitter: @kanza_tahreem
• LinkedIn: kanza-tahreem

(back to top)

🔭 Future Features

• Add more greeting messages.

(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 like this project, please give it a star ✨

(back to top)

🙏 Acknowledgments

Thank you to microverse for giving me the opportunity to learn and grow as a developer.

(back to top)

📝 License

This project is MIT licensed.

(back to top)