inspecta/hello-rails-back-end

RAILS-BACKEND README

📗 Table of Contents

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

📖 RAILS-REACT

This is a simpe RESTFUL API that has an endpoint that fetches a random greeting everytime a user accesses the endpoint (http://localhost/api/v1/messages). It is build using Ruby on Rails and PostgreSQL.

The API is be served in a React Front End Application link

🛠 Built With

Tech Stack

Client

• Ruby

Front End

• React App

Database

• PostgreSQL

Key Features

Describe between 1-3 key features of the application.

• Fetch a random greeting everytime through an endpoint
• Provide access to this endpoint
• The API is served with a React front end application

(back to top)

Describe how a new developer could make use of your project.

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

Prerequisites

In order to run this project you need:

• Ruby and rails installed
• PostgreSQL server installed also

Setup

Clone this repository to your desired folder:

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

Install

Install this project and it's dependencies:

  cd hello-rails-back-end
  gem install

Usage

To run the project, execute the following command:

  ./bin/dev

Endpoint

To see the random message, enter this URL

  curl https://localhost:3000/api/v1/messages

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Author1

• GitHub: @inspecta
• Twitter: @djmulinde
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• Add security
• Build a complete API
• Write a document for the API

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project, please give it a star.

(back to top)

🙏 Acknowledgments

Give credit to everyone who inspired your codebase.

I would like to thank Microverse for their continued support. They've provided us with the reading material that have helped us to create this application.

(back to top)

❓ FAQ (OPTIONAL)

Add at least 2 questions new developers would ask when they decide to use your project.

• Can I reuse this code?

  • Yes sure, feel free.

• Are contributions welcome?

  • Yes please. Contact me at djmulinde@gmail.com and I will be happy to add you as a contributor.

(back to top)

📝 License

This project is MIT licensed.

(back to top)