Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wahaj-ali/hello-rails-back-end


https://github.com/wahaj-ali/hello-rails-back-end

Last synced: 15 days ago
JSON representation

Awesome Lists containing this project

README

        


hello-rails-back-end


# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [hello-rails-back-end](#hello-rails-back-end)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [Front-end App Link ](#front-end-app-link-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Run](#run)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# hello-rails-back-end

**hello-rails-back-end** is the backend part of the hello-rails-react project. It generates a random greeting message as an API in JSON format. Using the data from this API, I can show it on my front-end App made using React.

## 🛠 Built With

### Tech Stack

Server

back to top

## Key Features

- Generates random greetings message.

## Front-end App Link

Get [Front-end app](https://github.com/Wahaj-Ali/hello-react-front-end)

back to top

## 💻 Getting Started
### Prerequisites

* Make sure you have Ruby installed in your system. You can install it [here](https://www.ruby-lang.org/en/documentation/installation/)

* Get started with [Ruby on Rails](https://guides.rubyonrails.org/getting_started.html).

* Make sure you have [PostgreSQL](https://www.postgresql.org/) installed and running.

### Setup

* Clone this repository by running `git clone https://github.com/Wahaj-Ali/hello-rails-back-end.git` in your command line.

* Navigate to the repository by running `cd hello-rails-back-end`.

### Install

* Run `bundle install` to install all the gems.

### Run

* Change/include `host, username, password` according to your database server.
* Run `rails db:create` and `rails db:migrate`
* Run `rails db:seed` to enter some data into database.
* Run `rails s` to start the server.
* In your browser, go to `http://localhost:3000`.

back to top

## 👥 Authors

👤 **Wahaj Ali**

- GitHub: [@Wahaj-Ali](https://github.com/Wahaj-Ali)
- LinkedIn: [@wahaj-ali96](https://www.linkedin.com/in/wahaj-ali96/)

back to top

## 🔭 Future Features

- [ ] **Better user interface**

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Wahaj-Ali/hello-rails-back-end/issues)

back to top

## ⭐️ Show your support

Give a ⭐️ if you like this project!

back to top

## 🙏 Acknowledgments

- I would like to thank all code reviewers and coding partners for making this project better.

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

back to top