Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/larryivc/hello-rails-react


https://github.com/larryivc/hello-rails-react

Last synced: 4 days ago
JSON representation

Awesome Lists containing this project

README

        



Hello Rails React


# 📗 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)
- [Database](#database)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 [Hello Rail React]

**Hello Rails React** is an application that allows users to show a random greeting. The app is built with Ruby on Rails and React. The app consumes API from Hello Rails API using React.

## 🛠 Built With

### Tech Stack

Language




<>

Database

### Key Features

- [⭐️ Setup Rails app ]
- [⭐️ Setup Rails API ]
- [⭐️ Setup Webpack ]
- [⭐️ Setup React ]

(back to top)

## 💻 Getting Started

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

### Setup

Clone this repository to your desired folder:

Example commands:

```sh
cd my-folder

git clone [email protected]:LarryIVC/hello-rails-react.git
```

### Prerequisites

> You need the following tools be installed in your computer:

> - [Rails](https://guides.rubyonrails.org/)
> - [Git](https://www.linode.com/docs/guides/how-to-install-git-on-linux-mac-and-windows/)
> - [Ruby](https://github.com/microverseinc/curriculum-ruby/blob/main/simple-ruby/articles/ruby_installation_instructions.md)
> - [PostgreSQL](https://www.postgresql.org/download/)
> - [Node.js](https://nodejs.org/en/download/)
> - IDE

(back to top)

### Install

Install this project with:

```sh
cd hello-rails-react

bundle install

npm install
```

(back to top)

### 💾 Database

Create the databases and run migrations with:

```sh
rails db:drop

rails db:create

rails db:migrate
```

(back to top)

### Usage

To run the project, execute the following command:

Example command:

```sh
./bin/dev
```

(back to top)

## 👥 Authors

## 👤 **Larry Villegas**
- GitHub: [@LarryIVC](https://github.com/LarryIVC)
- Twitter: [@LarryVillegas](https://twitter.com/LarryVillegas)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/larryvillegascostas/)

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

Help me with your criticisms and your suggestions, you will be blessed for such a noble gesture and give me a ⭐️ if you like this project. click [here ⭐️](https://github.com/LarryIVC/hello-rails-react)

(back to top)

## 🙏 Acknowledgments

- I would like to thank *[Microverse](https://www.microverse.org/?grsf=l49pe7)* for this opportunity.

(back to top)

## 📝 License

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

(back to top)