Hello-Rails-React

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Author
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Hello-Rails-React

Hello-Rails-React is an educational project to set up a "Hello world" project as one app with Webpack.

🛠 Built With

• Programming Language: Ruby, JavaScript
• Framework: Ruby on Rails, React
• Linter: Rubocop, stylelint
• Code Editor: Visual Studio Code

Tech Stack

Client

• React.js

Server

• Ruby on Rails

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• A web browser like Google Chrome.
• A code editor like Visual Studio Code with Git and Ruby.

You can check if Git is installed by running the following command in the terminal.

$ git --version

Likewise for Ruby installation.

$ ruby --version && irb

To install rails, in the terminal kindly run this command

$ gem install rails

Setup

Clone this repository to your desired folder:

Install

Install this project with:

$ git clone git@github.com:mavericks-db/hello-rails-react.git
$ cd hello-rails-react/

Usage

To run the project, execute the following command:

$ ./bin/dev

Run tests

To install rspec, in the terminal kindly run this command

$ gem install rspec

To run tests, run the following command:

$ rspec ./spec/#{filename}_spec.rb

👥 Author

👤 Mavericks Balitaan

• GitHub: @mavericks-db
• Twitter: @mavericks_db
• LinkedIn: LinkedIn

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse and its Code Reviewers.

(back to top)

📝 License

This project is MIT licensed.

(back to top)