Jawad-Nazari / hello-rails-back-end

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Database
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 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

• Rails

Server

• Rails

Database

• PostgreSQL

Key Features

• Provide Endponit API

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Ruby installed and running
• Rails installed and running
• PostgreSQL installed and running

Setup

Clone this repository to your desired folder:

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

Install

Install the project dependencies, execute the following command in Bash:

  bundle install

Database

Create the database, execute the following command in Bash:

rails db:create
rails db:migrate

Usage

To run the project, execute the following command in Bash:

  rails server

Run Tests

To run the project tests, execute the following command:

 rspec spec

(back to top)

👥 Author / Owner

👤 Jawad Nazari

• GitHub: @Jawad-Nazari
• Twitter: @Nazari_Jawad58
• LinkedIn: @jawad-nazari

(back to top)

🔭 Future Features

• Making desktop view
• Impoving UI / UX of the application
• Improving Navigation

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a start if you like this project!

(back to top)

🙏 Acknowledgments

• I would like to thank the Microverse program!

(back to top)

📝 License

This project is MIT licensed.

(back to top)