hello-rails-backend

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Hello-Rails-Backend

Hello-rails-Backend is a simple rails api application which can be used as supporting backend project for frontend projects.

React Project using this Backend API: hello-react-front-end

🛠 Built With

Tech Stack

Client

• Rails

Server

• Ruby

Database

• PostgreSQL

Key Features

• Uses the RoR framework following MVC architecture
• Has a Database consisting random messages.
• Has a random_greeting API endpoint which can be used in front-end projects.

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Ruby
• Node.js and npm/yarn

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:tan12082001/project-hello-rails-back-end.git

Install

Install the dependencies:

• gem install

• yarn install/npm install

Create database:

• bin/rails db:create

• bin/rails db:seed (to populate database with sample data)

Usage

To run the server:

 rails assets:precompile
 
 rails server

Open http://localhost:3000 to view it in your browser.

Run tests

To run tests, run the following command:

rspec spec/

(back to top)

👥 Authors

👤 Tanmayi Manku

• GitHub: @tan12082001
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Create more API endpoints.
• Develop the app and add features.

(back to top)

🤝 Contributing

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

(back to top)

⭐️ Show your support

If you like this project Add a star to the repository!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for providing the required lessons and tutorials for successfully completing the project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)