Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/luffytaro22/hello-rails-back-end


https://github.com/luffytaro22/hello-rails-back-end

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

# πŸ“— Table of Contents

- [πŸ“— Table of Contents](#-table-of-contents)
- [πŸ“– Recipe App ](#-recipe-app-)
- [πŸ›  Built With ](#-built-with-)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [πŸ’» Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Usage](#usage)
- [Install](#install)
- [Run tests](#run-tests)
- [πŸ‘₯ 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 an API application that shows random greeting messages.

## 🎨 Front-end Repo

This project is working with this Front-end [GitHub repository](https://github.com/Luffytaro22/hello-react-front-end).

## πŸ›  Built With

### Tech Stack

Back-end

### Key Features
* Use of Rails framework.
* MVC architecture.
* Save and retrieve information from an API.

(back to top)

## πŸ’» Getting Started

### Prerequisites
In order to run this project you need to have:

- Installed Ruby and Rails.
- If you're using Windows, have installed WSL.
- If you're using MacOS, an option is using UTM.

### Setup
To clone this repository to your desired folder, run the following command:

```
git clone [email protected]:Luffytaro22/hello-rails-back-end.git
```

(back to top)

### Usage
To open a local server, type the following command:
```
rails server
```

(back to top)

### Install
To install all the ruby gems, use the following command:
```
bundle install
```
After installing the gems, run this commando to create and migrate a database:
```
rails db:create db:migrate db:seed
```

(back to top)

## πŸ‘₯ Authors

πŸ‘€ **Manuel SΓ‘nchez**

- GitHub: [@Luffytaro22](https://github.com/Luffytaro22)
- LinkedIn: [Manuel SΓ‘nchez](https://www.linkedin.com/in/manuel-alejandro-sanchez-sierra/)

(back to top)

## πŸ”­ Future Features
- [ ] **Implement more API endpoints.**

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support
If you like this project please give it a star ⭐️

(back to top)

## πŸ™ Acknowledgments

I would like to give credits to the following:
* **Microverse** for this readme template.

(back to top)

## πŸ“ License

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

(back to top)