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

This is a simple configuration about an API backend with rails
https://github.com/cesarherr/hello-rails-back-end

Last synced: about 2 months ago
JSON representation

This is a simple configuration about an API backend with rails

• Host: GitHub
• URL: https://github.com/cesarherr/hello-rails-back-end
• Owner: CesarHerr
• License: mit
• Created: 2023-10-24T14:54:07.000Z (over 2 years ago)
• Default Branch: dev
• Last Pushed: 2023-10-24T20:02:05.000Z (over 2 years ago)
• Last Synced: 2025-01-13T22:55:50.509Z (over 1 year ago)
• Language: Ruby
• Size: 42 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          




  
Hello Rails Back end




# 📗 Table of Contents

- [📖 About the Project](#about-project)

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

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

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

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Usage](#usage)

  - [Run Tests](#tests)

- [🚀 Front End](#front)  

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 Hello Rails Back end 

**Hello Rails Back end** In this project I implemented a simple Back end API with Rails and postgresql.

## 🛠 Built With 

### Tech Stack 

Ruby

  


    
# README


This README would normally document whatever steps are necessary to get the

application up and running.

Things you may want to cover:

* Ruby version

* System dependencies

* Configuration

* Database creation

* Database initialization

* Services (job queues, cache servers, search engines, etc.)

* Deployment instructions

* ...

      Ruby

    

    


      Ruby styles guide

    

    


      Ruby linters (Rubocop)

    

  


Rails

  


    


      Guide

    

  


 PostgreSQL 

  


    


      Documentation

    

  


### Key Features 

- **Ruby on rails**

- **Postgresql**

(back to top)


## 💻 Getting Started 

This repository includes files with ruby lenguage and SQL.

### Prerequisites

In order to run this project you need to have Ruby installed, check [this](https://github.com/CesarHerr/blogApp.git) documentation in order to know how to install it.

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder 

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

```

### Usage

To run the server

```sh

  rails s

```

To check the linters you can use the command:

```sh

  rubocop

```

To fix the linter use: 

```sh

  rubocop -A

```

## 🚀 React Front End connection 

This Rails API, was created to work with:

[React Front end](https://github.com/CesarHerr/hello-react-front-end)

(back to top)


## 👥 Authors 

👤 **Cesar Herrera**

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

-   LinkedIn: [Cesarherr](https://www.linkedin.com/in/cesarHerr/)

(back to top)


## 🔭 Future Features 

- [] **Deploy**

- [] **Give some Styling** 

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

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

(back to top)


## ⭐️ Show your support 

If you like this project you could clone the repo and work with it or do the changes in a new branch. Also you could let a message with your thoughts.

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse for providing the necessary resources and all the effort from each member to complete this project.

(back to top)


## 📝 License 

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

(back to top)