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

https://github.com/yacoubou-seidou/hello-rails-back-end


https://github.com/yacoubou-seidou/hello-rails-back-end

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

# Hello rails back-end

## View

[Link to front-end](https://github.com/Yacoubou-seidou/hello-react-front-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)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 [Hello rails back-end]

**[Hello rails back-end]** is an backend app that respond with random greetings to requests.

## 🛠 Built With

### Tech Stack

Ruby on Rails

### Key Features

- **[Generate random greetings]**

(back to top)

## 💻 Getting Started

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

### Prerequisites

In order to run this project you need:

- Install Ruby
- Install Rails
- Install Postgresql

### Setup

Clone this repository to your desired folder:

```
cd hello-rails-back-end
git clone https://github.com/Yacoubou-seidou/hello-rails-back-end.git
```

### Install

Install this project with:

```
cd hello-rails-back-end
bundle install
rails db:create
rails db:migrate
rails db:seed
```
### Usage

To run the project, execute the following command:

```
# config/initializers/cors.rb

Rails.application.config.middleware.insert_before 0, Rack::Cors do
allow do
origins 'http://localhost:3001' # Change this to your frontend URL to avoid cors errors
end
end
```
```
then terminal run :
rails s
```
```
also_need_front_end:
git clone https://github.com/Yacoubou-seidou/hello-react-front-end.git
Follow instruction in the readme.md file
```

### Run tests

To run tests, run the following command:

```
rubocop --color
```
```
rspec
```

(back to top)

## 👥 Authors

👤 **Yacoubou Seidou**

- GitHub: [@Yacoubou-seidou](https://github.com/Yacoubou-seidou)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/yacoubou-seidou-chaibou/)

(back to top)

## 🔭 Future Features

- [ ] **[Adding more Languages]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

If you like this project please show support by staring ⭐️.

(back to top)

## 🙏 Acknowledgments

- Thanks to the Microverse team for the great curriculum.

(back to top)

## 📝 License

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

(back to top)