Microverse README Template

📗 Table of Contents

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

📖 [Hello Rails React]

Describe your project in 1 or 2 sentences.

[Hello rails react] is a simple web app to test working with rails and react

🛠 Built With

Tech Stack

Describe the tech stack and include only the relevant sections that apply to your project.

Client

• React.js

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

Describe between 1-3 key features of the application.

• [This app has API end points]
• [It fetches from the API and renders the data]
• [It renders random greetings on refreshing and navigating to the './message']

(back to top)

🚀 Live Demo

Add a link to your deployed project.

• Coming Soon

(back to top)

💻 Getting Started

Describe how a new developer could make use of your project.

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

Prerequisites

In order to run this project you need:

• Ruby
• Postgresql
• Node.js
• Yarn
• Rails

Setup

Clone this repository to your desired folder by running these commands:

• $ git clone https://github.com/techwolf404/hello_rails_react.git
• $ cd hello_rails_react

Install

Install this project with: Run

$ bundle install

To get all the gems required for the project

Then, run

$ npm install

To install packages such as style linters

To check linters locally, use

$ rubocop
$ npx stylelint "**/*.{css,scss}"

Once you have the project correctly set up, run

$ bin/rails db:setup

Usage

To run the project, execute the following command:

• ./bin/dev or rails s

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Hatim Eddinani

• GitHub: @techwolf404
• Twitter: @the_BwoyProgrmmr
• LinkedIn: @Hatim Eddinani

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project give a ⭐️ and follow my profile links so that we can connect

(back to top)

🙏 Acknowledgments

Give credit to everyone who inspired your codebase.

I would like to thank Microverse for this opportunity

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)