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

https://github.com/camerodev/ruby-on-rails-react


https://github.com/camerodev/ruby-on-rails-react

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        


logo


Ruby on Rails React


# πŸ“— Table of Contents

- [πŸ“– About the Project](#about-project)
- [πŸ›  Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [πŸš€ Live Demo](#live-demo)
- [πŸ’» Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [πŸ‘₯ Authors](#authors)
- [πŸ”­ Future Features](#future-features)
- [🀝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [πŸ”­ Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [πŸ“ License](#license)

This application allows you to:

- See a random greeting

## πŸ›  Built With

### Tech Stack

Technology


  • Ruby

  • Rails

  • PostgresSQL

Tools


  • VS Code

  • GIT

  • GITHUB

### Key Features

- Use Postgres database.
- Use React to fetch the API
- Use WebPack to pack the JavaScript code

(back to top)

## πŸš€ Live Demo

- Sorry, Currently not available

(back to top)

## πŸ’» Getting Started

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

### Prerequisites

you have to those tools in your local machine.

- [ ] Ruby
- [ ] Rails
- [ ] PostgresSQL
- [ ] GIT & GITHUB
- [ ] Any Code Editor (VS Code, Brackets, etc)

### Clone Repo

Clone the project using the following bash command in an appropriate location.

```bash
git clone https://github.com/PierreBarba/Ruby-on-Rails-React.git
```

Go to the project directory.

```bash
cd Ruby-on-Rails-React
```

To learn more [check Custom Credentials](https://edgeguides.rubyonrails.org/security.html#custom-credentials) documentation.

### Add necessary packages

For installing necessary packages, run the following bash command:

```bash
bundle install
```

### Run the server in development mode

In the project directory, you can run the project by using following bash command:

```bash
./bin/dev
```

And now you can visit the site with the URL http://localhost:3000

### Run the test

For testing you can run:

```bash
bundle exec rspec
```

(back to top)

## πŸ‘₯ Authors

**Jean Pierre Barba**

[![portfolio](https://img.shields.io/badge/my_portfolio-000?style=for-the-badge&logo=ko-fi&logoColor=white)](https://github.com/PierreBarba) [![linkedin](https://img.shields.io/badge/PierreBarba-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/jean-pierre-barba/)

(back to top)

## πŸ”­ Future Features

- [ ] **Live demo will added soon**

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/PierreBarba/Ruby-on-Rails-React/issues).

(back to top)

## πŸ‘‹ Show your support

Give a ⭐️ if you like this project!

(back to top)

## πŸ”­Acknowledgments

- My Family.
- [Microverse](microverse.org)

(back to top)

## ❓ FAQ

- **Can I use this project for personal use?**

- Yes, you can use it.

(back to top)

## πŸ“ License

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