[](#contributors-)

CHOCOLATE MINT BY DEVSOC

About

Chocolate Mint is a Command Line slug generator that let's user shorten their long command line code and generate a custom command line code for it.

Table of Contents

• Quick Start 🚀
• Documentations 🧾
• File Structure 📊
• Platform Support 🌐
• Contribution ✒
• Community 🤼
• Contributors ❤

Quick Start

1. Fork the project and then clone it into desired directory.

git clone https://github.com/YOUR_USERNAME/chocolate-mint.git

2. Run docker-compose to start your client and server

docker-compose up

If there is change in package.json then we will need to use this command:

docker-compose up --build

Documentation

File Structure

Platform Support

Contribution Guidelines

Refer to Quick Start 🚀 section to set up the development environment

Commit Messages

1. Commit messages are communication and documentation. They're a log of more than just what happened, they're about why it was done.
2. The longer a project is active, the more people involved, the larger the codebase, the more important it is to have good commit messages.
3. Make sure every change that you make is well documented and is included in your commit message.
4. One commit should have only one change. (A change may include multiple file changes that are essential to solving the issue/change).
5. All commit messages should be in the imperative-present tense. After all, you are telling us what you have already done.

Pull Request Guidelines

1. The subject line should be a one-sentence summary, and should not include the word and (explicitly or implied).
2. Any extra detail should be provided in the body of the PR.
3. Don't submit unrelated changes in the same pull request.

TO DO

• Initialize Repo
• Finalize Tech Stack for CLI
• Finalize Tech Stack for Frontend
• Bootstrap Repo
• Complete README.md

Community

Social Media

Instagram: https://www.instagram.com/devsocbitsgoa

Devsoc's Website: https://devsoc.club/

Slack Community

Here's the link to our slack community under QOSI:

https://bp-gc.in/SlackQOSI

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Arpit Bhardwaj 🚧

snigdha2210 🚧

Ritvij Kumar Sharma 🚧

This project follows the all-contributors specification. Contributions of any kind welcome!