cancelei/hello-rails-react2

Main learning points: Use Ruby on Rails with React in the same repository.

React+Rails One Repo in Rails App

📗 Table of Contents

• 📗 Table of Contents
• [📖 React+Rails One Repo App ](#-React+Rails One Repo-app-)
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ (OPTIONAL)
  • 📝 License

📖 React+Rails One Repo App

React+Rails One Repo in Rails App is an exercise only repo, but features a random generated greeting message.

🛠 Built With

Tech Stack

So you want to lear more about the tech we have used for this project?

Server

• Ruby on Rails

Database

• PostgreSQL

Front-End

• React

Key Features

• Setup a Hybrid Repo, using RubyRails with React in one repository.
• Rails 7.1.1 (lastest)+ Postgres with rails-jsbundler that is connected to Webpacker

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps. Note: We are assuming you have pre-installed ruby, WSL, ubuntu and rails!

Prerequisites

In order to run this project you need:

first at all, install rails:

gem install rails -v 7.1.1

Setup

Clone this repository to your desired folder:

  cd your-folder
  git@github.com:cancelei/hello-rails-react2.git

Install

Install this project with:

  cd hello-rails-react2
  bundle install

Setting up the Data Base:

  "Set up Username and password information in the config/database.yml"
  rails db:create
  rails db:migrate
  rails db:seed

Usage

To run the project, execute the following command:

  ./bin/dev

Deployment

The deployment will be available soon !

(back to top)

👥 Authors

👤 Glauber Bannwart

• GitHub: @cancelei
• LinkedIn: Glauber Bannwart

(back to top)

🔭 Future Features

We this project can improve, we are planning to include the next features soon:

• User Interface, Controllers and Models
• [N/A] API documentation
• View Implementation

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Would you like to help?

If you like this project feel free to leave an start, as well if you have a suggestion feel free to visit issues page.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for creating this exercise-project.

(back to top)

❓ FAQ (OPTIONAL)

Learn more about FAQ below:

• How do I fix Linters errors if I modify the project?

  • for rubocop run

  rubocop -A

  • for Stylint run:

  npx stylelint "**/*.{css,scss}" --fix

(back to top)

📝 License

This project is MIT licensed.

(back to top)