Microverse README Template

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

Describe your project in 1 or 2 sentences.

**[Hello-Rails-React]**Ruby on Rails with React in one App. This app displays a random greeting on a button click

🛠 Built With

• Ruby
• Ruby on Rails
• Postgresql
• React
• WebPack
• VScode

Tech Stack

• Ruby
• Ruby on Rails
• Postgresql
• React

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

Client

• React.js

Server

• Express.js

Database

• PostgreSQL

Key Features

Describe between 1-3 key features of the application.

• [Display a greeting on the click of a button]

(back to top)

(back to top)

💻 Getting Started

This is an example of how you may give instructions on setting up your project locally. Modify this file to match your project, remove sections that don't apply. For example: delete the testing section if the currect project doesn't require testing.

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

Prerequisites

• A code editor ( VScode...).

Setup

To setup the project locally: clone the repository using:

git@github.com:Lancelot-SO/hello-rails-react.git

Install

run: rails server

Usage

Run tests

run: rspec

Deployment

login: localhost:3000

(back to top)

👥 Authors

👤 Felix Sowah

• GitHub: @Felix Sowah
• Twitter: @Felix Sowah
• LinkedIn: @Felix Sowah

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• [Create Add Greetings]

(back to top)

🤝 Contributing

CContributions, 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

• Grateful to anyone whose code served as reference
• Grateful to anyone who inspired me to create this wonderful project

(back to top)

❓ FAQ (OPTIONAL)

(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)