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

https://github.com/prangonghose/hello_rails_react

This is a demo application for practicing using `React` inside a `Rails API` project.
https://github.com/prangonghose/hello_rails_react

api-rest postgresql rails react webpack

Last synced: 3 months ago
JSON representation

This is a demo application for practicing using `React` inside a `Rails API` project.

Awesome Lists containing this project

README

          

React on Rails

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 Project Name

## Hello Rails with React

## About this project

This is a demo application for practicing using `React` inside a `Rails API` project.

## 🛠 Built With

- `Ruby`, `Ruby on Rails`, `JavaScript`, `HTML`, `CSS`, `React`

## 💻 Getting Started
To clone the repository in local environment try following steps.

### Prerequisites

- [x] A code editor like Visual Studio Code with Git and Node.js.

You can check if Git is installed by running the following command in the terminal.
```
$ git --version
```

Likewise for `Ruby` and `gem` for package installation.
```
$ ruby --version && gem --version
```
**Note: This project is built with `Ruby` version 3.1.3**
### Setup

Clone the repository using [this link](https://github.com/PrangonGhose/hello_rails_react).

### Install

In the terminal, go to your file directory and run this command.

```
$ git clone https://github.com/PrangonGhose/hello_rails_react
```
### Get into development

In the terminal, run these commands to get into development.
```
$ cd Rails-recipe

$ bundle init

$ bundle install (install dependencies)
```
**Note: You might need to update [database.yml](./config/database.yml) for development and testing environments with necessary username and password for your database in their respective positions.**
```
$ rails db:create

$ rails db:migrate

$ rails server

```

## 👥 Authors

👤 **Prangon Ghose**

- GitHub: [@PrangonGhose](https://github.com/PrangonGhose)
- LinkedIn: [Prangon Ghose](https://www.linkedin.com/in/prangon-ghose/)

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome! Add suggestions by opening new issues.

Feel free to check the [issues page](https://github.com/PrangonGhose/hello_rails_react/issues).

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

## 🙏 Acknowledgments

Authors would like to thank:
- [Microverse](https://www.microverse.org/)
- Code Reviewers
- Coding Partners

(back to top)

## 📝 License

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