https://github.com/inspecta/hello-rails-back-end
https://github.com/inspecta/hello-rails-back-end
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/inspecta/hello-rails-back-end
- Owner: inspecta
- License: other
- Created: 2023-02-21T09:25:13.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-21T17:30:25.000Z (over 3 years ago)
- Last Synced: 2025-12-30T17:35:19.381Z (6 months ago)
- Language: Ruby
- Size: 572 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
RAILS-BACKEND README
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
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](https://github.com/inspecta/hello-react-front-end)
Client
Front End
Database
> 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
> 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:
```sh
git clone https://github.com/inspecta/hello-rails-back-end.git
```
### Install
Install this project and it's dependencies:
```sh
cd hello-rails-back-end
gem install
```
### Usage
To run the project, execute the following command:
```sh
./bin/dev
```
### Endpoint
To see the random message, enter this URL
```sh
curl https://localhost:3000/api/v1/messages
```
> Mention all of the collaborators of this project.
👤 **Author1**
- GitHub: [@inspecta](https://github.com/inspecta)
- Twitter: [@djmulinde](https://twitter.com/djmulinde)
- LinkedIn: [LinkedIn](https://linkedin.com/in/mulinde-derrick)
> Describe 1 - 3 features you will add to the project.
- [ ] Add security
- [ ] Build a complete API
- [ ] Write a document for the API
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
> Write a message to encourage readers to support your project
If you like this project, please give it a star.
> 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.
> 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.
This project is [MIT](./LICENSE) licensed.