chepkok3/hello-rails-react

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 [HELO-RAILS-REACT]

[Hello rails react] is an application that facilitates a connection between a Ruby on Rails back-end and React front-end.

🛠 Built With

Tech Stack

• ROR
• Postgresql
• Rspec

Key Features

• [Users combine rails and react in one application]
• [Users consume API]

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need the following installed in your local system

• Ruby
• Git CLI
• Github account

Setup

Clone this repository to your desired folder:

  cd hello-rails-react
  git clone https://github.com/chepkok3/hello-rails-react.git

Install

Install this project with:

  cd hello-rails-react
  bundle install

Usage

To run the project, execute the following command:

./bin/dev

Run tests

• Type Rspec: To run test `
• Type npx stylelint "**/*.{css,scss}" to run for stylelint errors

(back to top)

👥 Authors

👤 Stanley Kibor

• GitHub: @chepkok3
• Twitter: @chepkok3
• LinkedIn: @chepkok3

(back to top)

🔭 Future Features

• [Style the UI]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please leave a STAR to the Github repo

(back to top)

🙏 Acknowledgments

I would like to appreciate Microverse for providing the learning resources for this exercise.

(back to top)

📝 License

This project is MIT licensed.

(back to top)