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

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

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/jecode93/hello-rails-react
• Owner: jecode93
• License: mit
• Created: 2023-11-27T20:17:53.000Z (over 2 years ago)
• Default Branch: dev
• Last Pushed: 2024-02-11T02:46:31.000Z (over 2 years ago)
• Last Synced: 2024-05-17T16:05:23.725Z (about 2 years ago)
• Language: Ruby
• Size: 3.13 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Hello Rails react project

# 📗 Table of Contents

- [Hello Rails react project](#hello-rails-react-project)

- [📗 Table of Contents](#-table-of-contents)

- [Rails Module](#rails-module)

  - [Built With](#built-with)

    - [Tech Stack ](#tech-stack-)

    - [Key Features ](#key-features-)

  - [Getting Started](#getting-started)

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Install](#install)

    - [Usage](#usage)

    - [Run tests](#run-tests)

    - [Deployment](#deployment)

  - [Authors](#authors)

  - [🔭 Future Features ](#-future-features-)

  - [🤝 Contributing](#-contributing)

  - [Show your support](#show-your-support)

  - [Acknowledgments](#acknowledgments)

  - [📝 License](#-license)

# Rails Module

> This is a one app setup using webpack with React for the front end, and Ruby on rails for the back end.

## Built With

- Ruby

- React

- Ruby on Rails

- PostgresSQL

- Tailwind CSS

### Tech Stack 

> 

  Language

  


    
Ruby

  


Framework

  


    
React

  

  


    
Ruby on Rails

  


Database

  


    
PostgresSQL

  


CSS Framework

  


    
Tailwind CSS

  


### Key Features 

> Some useful features

- **[Front end with React]**

- **[API backend with Rails]**

## Getting Started

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

### Prerequisites

- Visual Studio Code must be installed on your computer | Download Visual Studio Code [VSCode](https://code.visualstudio.com/)

- Git must be installed on your computer | Download [Git](https://git-scm.com/downloads)

### Setup

- Clone the repository

- Open the project folder in Visual Studio Code

### Install

Install this project using:

- cd project/directory

- Git clone [Hello Rails React](https://github.com/jecode93/hello-rails-react.git)

### Usage

To run the project, execute the following command:

- Launch index.html file in your browser

### Run tests

To run tests, run the following command:

- Rails server (In the command line)

- Go to http://127.0.0.1:3000

- Enjoy

### Deployment

You can deploy this project using:

- [Netlify](https://www.netlify.com/)

- [Render](https://pages.github.com/)

(back to top)


(back to top)


## Authors

👤 **Jean Emmanuel Cadet**

- GitHub: [@jecode93](https://github.com/jecode93)

- LinkedIn: [jean-emmanuel-cadet](https://www.linkedin.com/in/jean-emmanuel-cadet/)

- Facebook: [@jecode93](https://www.facebook.com/jecode93)

- Instagram: [@jecode93](https://instagram.com/jecode93)

- Twitter: [@jecode93](https://twitter.com/jecode93)

## 🔭 Future Features 

- [ ] **[Desktop version]**

(back to top)


## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

- Thanks to the Microverse team for the great curriculum.

- Thanks to the Code Reviewer(s) for the insightful feedback.

- A great thanks to My coding partner(s), morning session team, and standup team for their contributions.

## 📝 License

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