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

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

Last synced: about 1 hour ago
JSON representation

• Host: GitHub
• URL: https://github.com/alvp01/hello-rails-back-end
• Owner: alvp01
• License: mit
• Created: 2023-12-15T20:31:25.000Z (about 1 year ago)
• Default Branch: dev
• Last Pushed: 2023-12-17T00:06:14.000Z (about 1 year ago)
• Last Synced: 2025-01-13T14:51:56.957Z (4 days ago)
• Language: Ruby
• Size: 371 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        




  
Rails Greetings API app



# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)

- [📖 Rails Greetings API app ](#-rails-greetings-api-app-)

  - [🛠 Built With ](#-built-with-)

    - [Tech Stack ](#tech-stack-)

  - [🔗 Integration with Hello React Front-End ](#-integration-with-hello-react-front-end-)

    - [Key Features ](#key-features-)

  - [💻 Getting Started ](#-getting-started-)

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Install](#install)

    - [Usage](#usage)

    - [Deployment](#deployment)

  - [👥 Authors ](#-authors-)

  - [🤝 Contributing ](#-contributing-)

  - [⭐️ Show your support ](#️-show-your-support-)

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [❓ FAQ (OPTIONAL) ](#-faq-optional-)

  - [📝 License ](#-license-)

# 📖 Rails Greetings API app 

**Rails Greetings API app** is an exercise only repo, but features a random generated greeting message.

## 🛠 Built With 

### Tech Stack 

> So you want to lear more about the tech we have used for this project?

**Server**

Ruby on Rails

**Database**

PostgreSQL

## 🔗 Integration with Hello React Front-End 

The front-end link [Hello Rails Front-End](https://github.com/alvp01/hello-react-front-end) project.

(back to top)


### Key Features 



  
Ruby on Rails framework

  


    Use Linters to check code quality

    


      
Rubocop

    

  

  
MVC architectural/design pattern

  
Data persistent in PostgreSQL

  
RESTful API



(back to top)


## 💻 Getting Started 

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

Note: We are assuming you have pre-installed ruby, WSL, ubuntu and rails!

### Prerequisites

In order to run this project you need:

first at all, install rails:

```sh

gem install rails

```

### Setup

Clone this repository to your desired folder:

```sh

  cd your-folder

  [email protected]:alvp01/hello-rails-back-end.git

```

### Install

Install this project with:

```sh

  cd hello-rails-back-end

  bundle install

```

Setting up the Data Base:

```sh

  "Set up Username and password information in the config/database.yml"

  rails db:create

  rails db:migrate

  rails db:seed

```

### Usage

To run the project, execute the following command:

```sh

  rails s

```

### Deployment

The deployment will be available soon !

(back to top)


## 👥 Authors 

👤 **Abel Lavieri**

- GitHub: [@alvp01](https://github.com/alvp01)

- LinkedIn: [Abel Lavieri](https://www.linkedin.com/in/abel-lavieri)

  

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/cancelei/hello-rails-react2/issues).

(back to top)


## ⭐️ Show your support 

> Would you like to help?

If you like this project feel free to leave an start, as well if you have a suggestion feel free to visit issues page.

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse for creating this exercise-project.

(back to top)


## ❓ FAQ (OPTIONAL) 

> Learn more about FAQ below:

- **How do I fix Linters errors if I modify the project?**

  - for rubocop run

  ```sh

  rubocop -A

  ```

(back to top)


## 📝 License 

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

(back to top)