diff --git a/README.md b/README.md index c8a41ee..864913b 100644 --- a/README.md +++ b/README.md @@ -8,38 +8,46 @@ --- -[![DOCS](https://img.shields.io/badge/Documentation-see%20docs-green?style=flat-square&logo=appveyor)](INSERT_LINK_FOR_DOCS_HERE) - [![UI ](https://img.shields.io/badge/User%20Interface-Link%20to%20UI-orange?style=flat-square&logo=appveyor)](INSERT_UI_LINK_HERE) +[![DOCS](https://img.shields.io/badge/Documentation-see%20docs-green?style=flat-square&logo=appveyor)](INSERT_LINK_FOR_DOCS_HERE) +[![UI ](https://img.shields.io/badge/User%20Interface-Link%20to%20UI-orange?style=flat-square&logo=appveyor)](INSERT_UI_LINK_HERE) [![GitHub Super-Linter](https://github.com///workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter) + ## Features + - Insert list of features here ## Screenshots +

Common-Entry-Test

- ## Dependencies - - < dependency > - - < dependency > + +- < dependency > +- < dependency > + ## Instructions #### Directions to Install + ```sh -$ git clone https://github.com/CodeChefVIT/ -$ cd -$ npm install +$ git clone https://github.com/CodeChefVIT/cookoff-backend +$ cd cookoff-backend ``` + #### Directions to Run + ```sh -$ npm serve +$ docker compose up --build -d ``` + ## Contributors + - + + + + +
- John Doe + Aman L

Your Name Here (Insert Your Image Link In Src

@@ -49,13 +57,48 @@ $ npm serve

- John Doe + + Akshat Gupta

- Your Name Here (Insert Your Image Link In Src + Akshat Gupta

- + + GitHub + +

+
+ Prateek Srivastava +

+ Prateek Srivastava +

+

+ + GitHub + +

+
+ Vedant Matanhelia +

+ Vedant Matanhelia +

+

+ + GitHub + +

+
+ Tanvi Jain +

+ Tanvi Jain +

+

+ GitHub

@@ -64,6 +107,7 @@ $ npm serve
## License + [![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://badges.mit-license.org)