Skip to content

Commit

Permalink
feat: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
RustyDev24 committed Feb 8, 2024
1 parent e0a1aa1 commit 3198bb4
Showing 1 changed file with 58 additions and 14 deletions.
72 changes: 58 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<OWNER>/<REPOSITORY>/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter)

## Features

- Insert list of features here

## Screenshots

<p align="center">
<img src="https://i.ibb.co/VppxmWZ/cet.png" alt="Common-Entry-Test" width="400px"/>
</p>


## Dependencies
- < dependency >
- < dependency >

- < dependency >
- < dependency >

## Instructions

#### Directions to Install

```sh
$ git clone https://github.com/CodeChefVIT/<Project>
$ cd <Project>
$ 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

<table>
<tr align="center" style="font-weight:bold">
<td>
John Doe
Aman L
<p align="center">
<img src = "https://i.ibb.co/4J9LXxS/cclogo.png" width="150" height="150" alt="Your Name Here (Insert Your Image Link In Src">
</p>
Expand All @@ -49,13 +57,48 @@ $ npm serve
</a>
</p>
</td>
<td>
John Doe
<td>
Akshat Gupta
<p align="center">
<img src = "https://i.ibb.co/4J9LXxS/cclogo.png" width="150" height="150" alt="Your Name Here (Insert Your Image Link In Src">
<img src = "https://avatars.githubusercontent.com/u/84951451?v=4" width="150" height="150" alt="Akshat Gupta">
</p>
<p align="center">
<a href = "https://github.com/<GitHub-username>">
<a href = "https://github.com/Oik17">
<img src = "http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height = "36" alt="GitHub"/>
</a>
</p>
</td>
<td>
Prateek Srivastava
<p align="center">
<img src = "https://avatars.githubusercontent.com/u/133687995?v=4" width="150" height="150" alt="Prateek Srivastava">
</p>
<p align="center">
<a href = "https://github.com/prateek-srivastava001">
<img src = "http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height = "36" alt="GitHub"/>
</a>
</p>
</td>
<td>
Vedant Matanhelia
<p align="center">
<img src = "https://avatars.githubusercontent.com/u/71623796?v=4" width="150" height="150" alt="Vedant Matanhelia">
</p>
<p align="center">
<a href = "https://github.com/Black-Sirius69">
<img src = "http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height = "36" alt="GitHub"/>
</a>
</p>
</td>
</tr>
<tr>
<td>
Tanvi Jain
<p align="center">
<img src = "https://avatars.githubusercontent.com/u/126889779?v=4" width="150" height="150" alt="Tanvi Jain">
</p>
<p align="center">
<a href = "https://github.com/Tnvj">
<img src = "http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height = "36" alt="GitHub"/>
</a>
</p>
Expand All @@ -64,6 +107,7 @@ $ npm serve
</table>

## License

[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://badges.mit-license.org)

<p align="center">
Expand Down

0 comments on commit 3198bb4

Please # to comment.