Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@Abh1noob
Abh1noob authored Mar 29, 2024
1 parent 4b84e1f commit c4b3796
Showing 1 changed file with 148 additions and 47 deletions.
195 changes: 148 additions & 47 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,69 +1,170 @@
<p align="center"><a href="https://www.codechefvit.com" target="_blank"><img src="https://i.ibb.co/4J9LXxS/cclogo.png" width=160 title="CodeChef-VIT" alt="Codechef-VIT"></a>
</p>

<h2 align="center"> Project Title </h2>
<h2 align="center"> DEVSOC'24 Portal</h2>
<br/>

> Include project description here.
> <p>Welcome to the code DEVSOC'24 Portal, your one-stop solution where participants manage all their event related logistics, from creating a team to submitting the final project, Our powerful and user-friendly tools are poised to facilitate your every step with utmost efficiency and ease.</p>
---
## ⚙️ Tech Stack:

[![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
- T3
- TypeScript
- Tailwind CSS
- Framer Motion
- Zod
- Zustand
- React Hot Toast
- Axios
- Shadcn
- Yup

## 💡 Features:

- Create User
- Create/Join Team
- Add/Edit Idea
- Add/Edit Project
- Notice flash through banner
- Timeline and Track Details

## 🖼 Screenshots

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

#### Signup Page

<img width="1440" alt="image" src="">

#### Login Page

<img width="1440" alt="image" src="">

### Home Screen

<img width="1440" alt="image" src="">

</p>

## 🏁 Get Started

## Dependencies
- < dependency >
- < dependency >
## Instructions
To get started, fork your own copy and clone the master branch. To clone a branch you can run the following:

#### Directions to Install
```sh
$ git clone https://github.com/CodeChefVIT/<Project>
$ cd <Project>
$ npm install
```bash
git clone -b master https://github.com/<Your username>/devsoc24-portal-fe.git
```
#### Directions to Run
```sh
$ npm serve

Run these commands on your bash/terminal and open it in a code editor of your choice.

Run the following to install all the dependencies:

```bash
pnpm i
```
## Contributors

To start your development server run:

```bash
pnpm dev
```

## 📝 Note:

To have the entire functionality please note that you will have to either create your own backend or fork the official backend of DEVSOC'24 :
[https://github.com/CodeChefVIT/devsoc-backend-24](https://github.com/CodeChefVIT/devsoc-backend-24)

You can also make a forked copy of the Admin Portal by heading over to: [https://github.com/CodeChefVIT/devsoc24-admin](https://github.com/CodeChefVIT/devsoc24-admin)

Make sure you set user role as 'admin' in database to access all the admin specific APIs.

## 🚀 Contributors

<table>
<tr align="center" style="font-weight:bold">
<td>
John Doe
<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>
<p align="center">
<a href = "https://github.com/<GitHub-username>">
<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>
John Doe
<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>
<p align="center">
<a href = "https://github.com/<GitHub-username>">
<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 align="center">
<td>
<p align="center">
<img src = "https://avatars.githubusercontent.com/u/91564450?v=4" width="200" height="200" alt="Aaditya" style="border: 2px solid grey; width: 170px; height: 170px">
</p>
<p style="font-size:17px; font-weight:600;">Aaditya Mahanta</p>
<p align="center">
<a href = "https://github.com/aditansh"><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>
<a href = "https://www.linkedin.com/in/aadityamahanta/">
<img src = "http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
</a>
</p>
</td>

<td>
<p align="center">
<img src = "https://avatars.githubusercontent.com/u/84934511?v=4" width="200" height="200" alt="profilepic" style="border: 2px solid grey; width: 170px; height:170px">
</p>
<p style="font-size:17px; font-weight:600;">Nishant Gupta</p>
<p align="center">
<a href = "https://github.com/NishantGupt786"><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>
<a href = "https://www.linkedin.com/in/nishant-gupta-12913221b/">
<img src = "http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
</a>
</p>
</td>

<td>
<p align="center">
<img src = "https://avatars.githubusercontent.com/u/56132559?v=4" width="200" height="200" alt="profilepic" style="border: 2px solid grey; width: 170px; height:170px">
</p>
<p style="font-size:17px; font-weight:600;">Abhinav Ganeshan</p>
<p align="center">
<a href = "https://github.com/Abh1noob"><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>
<a href = "https://www.linkedin.com/in/abhinav-gk/">
<img src = "http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
</a>
</p>
</td>
</tr>

<tr align="center">
<td>
<p align="center">
<img src = "https://avatars.githubusercontent.com/u/130531520?v=4" width="200" height="200" alt="profilepic" style="border: 2px solid grey; width: 170px; height:170px">
</p>
<p style="font-size:17px; font-weight:600;">Saanvi Iyer</p>
<p align="center">
<a href = "https://github.com/saanvi-iyer"><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>
<a href = "https://www.linkedin.com/in/saanviiyer/">
<img src = "http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
</a>
</p>
</td>

<td>
<p align="center">
<img src = "https://avatars.githubusercontent.com/u/115492119?v=4" width="200" height="200" alt="profilepic" style="border: 2px solid grey; width: 170px; height:170px">
</p>
<p style="font-size:17px; font-weight:600;">Shiv Deshpande</p>
<p align="center">
<a href = "https://github.com/Shivd131"><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>
<a href = "https://www.linkedin.com/in/shiv-deshpande-951b9a23b/">
<img src = "http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
</a>
</p>
</td>

<td>
<p align="center">
<img src = "https://avatars.githubusercontent.com/u/113667044?v=4" width="200" height="200" alt="profilepic" style="border: 2px solid grey; width: 170px; height:170px">
</p>
<p style="font-size:17px; font-weight:600;">Pranav Deshmukh</p>
<p align="center">
<a href = "https://github.com/pranav-deshmukh"><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>
<a href = "https://www.linkedin.com/in/pranavdeshmukh910/">
<img src = "http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
</a>
</p>
</td>
</tr>
</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 c4b3796

Please sign in to comment.