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

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


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

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

        

# 📗 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)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 [HELO-RAILS-REACT]

**[Hello rails react]** is an application designed for combination of react and rails.

## 🛠 Built With

### Tech Stack

- ROR
- Postgresql
- Rspec

### Key Features

- **[Users combine rails and react in one application]**
- **[Users consume API]**

(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 the following installed in your local system


  • Ruby

  • Git CLI

  • Github account

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/quavo19/hello-rails-react.git
```

### Install

Install this project with:

```sh
cd budget_app
bundle install
```

### Usage

To run the project, execute the following command:

``` sh
rails s
```
### Run tests

- Type `Rspec`: To run test `
- Type `npx stylelint "**/*.{css,scss}"` to run for stylelint errors

(back to top)

## 👥 Authors

👤 **Akite Donald**

- GitHub: [@githubhandle](https://github.com/quavo19)
- Twitter: [@twitterhandle](https://twitter.com/DonaldAkite)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/donald-akite-299a31222/)

(back to top)

## 🔭 Future Features

- [ ] **[Style components]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

If you like this project please leave a STAR to the [Github repo](https://github.com/quavo19/
hello-rails-react/)

(back to top)

## 🙏 Acknowledgments

I would like to appreciate [Microverse](https://www.microverse.org/) for providing the learning resources for this exercise, and I would specially thank [Gregoire Vella](https://www.behance.net/gregoirevella) who is the original author of this [design](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding?tracking_source=)

(back to top)

## 📝 License

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

(back to top)