https://github.com/alierpm/hello-rails-react
https://github.com/alierpm/hello-rails-react
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/alierpm/hello-rails-react
- Owner: AlierPM
- License: mit
- Created: 2024-02-27T17:40:47.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2024-02-28T15:30:27.000Z (over 1 year ago)
- Last Synced: 2025-02-04T13:44:14.492Z (4 months ago)
- Language: Ruby
- Size: 238 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: License
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)
- [🚀 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)
# 📖 hello-rails-react
> A project connecting Ruby on Rails back-end with React front-end using Webpack and jsbundling-rails gem.
## 🛠 Built With
### Tech Stack
Client
Unit Testing
## 🚀 Live Demo
> Live Demo coming SOON!
- [Coming soon....](https://yourdeployedapplicationlink.com)
## 💻 Getting Started
> The following steps were used in creating this project:
1. Set up the project by creating a new directory from the generated repository.
2. Set up the repository on GitHub and use Gitflow.
3. Initialize the project with Rubocop linters.
### Prerequisites
In order to run this project, you need:
1. Ruby installed:
- On macOS using Homebrew:
```sh
brew install ruby
```
- On Windows or Linux, follow the installation instructions from [Ruby's official website](https://www.ruby-lang.org/en/documentation/installation/).
2. Rails Installed:
```sh
gem install rails
3. Usage:
Open the project in your preferred code editor:
```sh
cd hello-rails-react
code .
```
4. Run project
> To run from the local server, execute the following command:
```sh
./bin/dev
```
## 🚀 Meet the Visionary
👤 **Alier Philip Maguet**
- GitHub: [@AlierPM](https://github.com/AlierPM)
- Twitter: [@AlierPM](https://twitter.com/AlierPM)
- LinkedIn: [@AlierPM](https://www.linkedin.com/in/alierphilipmaguet/)
## 🔭 Future Features
- [ ] Add more features to the project
### 🌟 Join the Adventure
Ready to contribute, share ideas, or spot an issue? We're all ears!
Check out the issues page to dive into the action.
### 🌈 Be the Wind Beneath Our Wings
Your positive vibes and constructive feedback fuel our journey towards continuous improvement.
If you resonate with this project...
> Burning questions? Let's put out the fire.
- **How swiftly did the magic happen?**
- [x] Conjured up in just 6 hours
- **Count of git conflicts vanquished?**
- [x] Successfully tamed more than five (5) conflicts
This project is licensed under [MIT](./License).