https://github.com/indiecodermm/ruby-template
Template for Ruby projects
https://github.com/indiecodermm/ruby-template
Last synced: 11 months ago
JSON representation
Template for Ruby projects
- Host: GitHub
- URL: https://github.com/indiecodermm/ruby-template
- Owner: IndieCoderMM
- License: mit
- Created: 2023-03-08T16:38:16.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-22T09:04:48.000Z (almost 3 years ago)
- Last Synced: 2025-01-16T00:09:58.741Z (about 1 year ago)
- Language: Ruby
- Size: 3.91 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![License][license-shield]][license-url]
Table of Contents
- [💎 Awesome Project](#-awesome-project)
- [📸 Screenshot](#-screenshot)
- [🧰 Tech Stack](#-tech-stack)
- [✨ Key Features](#-key-features)
- [🚀 Live Demo](#-live-demo)
- [💻 Getting Started](#-getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Installation](#installation)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#-authors)
- [🔭 Future Features](#-future-features)
- [🤝 Contributing](#-contributing)
- [💖 Show your support](#-show-your-support)
- [🙏 Acknowledgments](#-acknowledgments)
- [📜 License](#-license)
# 💎 Awesome Project
> Describe your project in 1 or 2 sentences.
This is a template for **Ruby** projects.
## 📸 Screenshot
## 🧰 Tech Stack
> Describe the tech stack and include only the relevant sections that apply to your project.
Client
Server
Database
## ✨ Key Features
> Describe between 1-3 key features of the application.
- **[key_feature_1]**
- **[key_feature_2]**
- **[key_feature_3]**
## 🚀 Live Demo
> Add a link to your deployed project.
- [Live Demo Link](https://google.com)
## 💻 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](https://www.ruby-lang.org/en/) installed on your machine.
### Setup
Clone this repository to your desired folder:
```sh
cd my-project
git clone git@github.com:IndieCoderMM/awesome-project.git .
```
### Installation
Install this project with:
```sh
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:
## 👥 Authors
> Mention all of the collaborators of this project.
👨🚀 **Hein Thant**
- GitHub: [@githubhandle](https://github.com/indiecodermm)
- LinkedIn: [LinkedIn](https://linkedin.com/in/hthantoo)
- Gmail: hthant00chk@gmail.com
👤 **Author2**
- GitHub: [@githubhandle](https://github.com/githubhandle)
- Twitter: [@twitterhandle](https://twitter.com/twitterhandle)
- LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle)
## 🔭 Future Features
> Describe 1 - 3 features you will add to the project.
- [ ] **[new_feature_1]**
- [ ] **[new_feature_2]**
- [ ] **[new_feature_3]**
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## 💖 Show your support
If you like this project, please consider giving it a ⭐.
## 🙏 Acknowledgments
I would like to thank all code reviewers for making this project better.
## 📜 License
This project is [MIT](./LICENSE) licensed.
[contributors-shield]: https://img.shields.io/github/contributors/indiecodermm/ruby-template
[contributors-url]: https://github.com/indiecodermm/ruby-template/graphs/contributors
[stars-shield]: https://img.shields.io/github/stars/indiecodermm/ruby-template
[stars-url]: https://github.com/indiecodermm/ruby-template/stargazers
[issues-shield]: https://img.shields.io/github/issues/indiecodermm/ruby-template
[issues-url]: https://github.com/indiecodermm/ruby-template/issues
[license-shield]: https://img.shields.io/github/license/indiecodermm/ruby-template
[license-url]: https://github.com/indiecodermm/ruby-template/blob/main/LICENSE