Table of Contents

• 💎 Awesome Project
  • 📸 Screenshot
  • 🧰 Tech Stack
  • ✨ Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Installation
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • 💖 Show your support
  • 🙏 Acknowledgments
  • 📜 License

💎 Awesome Project

Describe your project in 1 or 2 sentences.

This is a template for Ruby projects.

📸 Screenshot

(back to top)

🧰 Tech Stack

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

Client

• React.js

Server

• Express.js

Database

• PostgreSQL

(back to top)

✨ Key Features

Describe between 1-3 key features of the application.

• [key_feature_1]
• [key_feature_2]
• [key_feature_3]

(back to top)

🚀 Live Demo

Add a link to your deployed project.

• Live Demo Link

(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 installed on your machine.

Setup

Clone this repository to your desired folder:

  cd my-project
  git clone [email protected]:IndieCoderMM/awesome-project.git .

Installation

Install this project with:

  gem install

Usage

To run the project, execute the following command:

Run tests

To run tests, run the following command:

Deployment

You can deploy this project using:

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👨‍🚀 Hein Thant

• GitHub: @githubhandle
• LinkedIn: LinkedIn
• Gmail: [email protected]

👤 Author2

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

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

• [new_feature_1]
• [new_feature_2]
• [new_feature_3]

(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 consider giving it a ⭐.

(back to top)

🙏 Acknowledgments

I would like to thank all code reviewers for making this project better.

(back to top)

📜 License

This project is MIT licensed.

(back to top)