Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README for navigable table of contents #733

Closed
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,17 @@ A <b> responsive and dynamic website </b> to showcase the best gaming accessorie
</tbody>
</table>

## Table of Contents
- [✨ Features](#features)
- [💻 Technologies Used](#technologies-used)
- [⚙️ Backend Setup](#backend-setup)
- [🚀 Demo](#demo)
- [🛠️ Installation](#installation)
- [🤝 Contributing](#contributing)
- [👥 Team](#team)
- [🙌Contributors](#contributors)

<a id="features"></a>
## ✨ Features
🗂️ <b>Dynamic Navigation Menu</b>: Toggle visibility, designed for seamless use across all screen sizes.

Expand All @@ -32,15 +43,16 @@ A <b> responsive and dynamic website </b> to showcase the best gaming accessorie
📱 <b>Responsive Design</b>: Enjoy smooth navigation whether you're on mobile, tablet, or desktop!



## 💻 Technologies Used ( Frontend )
<a id="technologies-used"></a>
## 💻 Technologies Used
### Frontend
<p align="center">
<a href="https://skillicons.dev">
<img src="https://skillicons.dev/icons?i=html,css,js" />
</a>
</p>

## 💻 Technologies Used ( Backend & Docker Functionality )
### Backend & Docker Functionality

- 🟢 **Node.js** and **Express** for the backend
- 🍃 **MongoDB** for database storage
Expand All @@ -52,6 +64,7 @@ A <b> responsive and dynamic website </b> to showcase the best gaming accessorie
</a>
</p>

<a id="backend-setup"></a>
## ⚙️ Backend Setup
1. Clone the repository:
```bash
Expand Down Expand Up @@ -87,11 +100,13 @@ Run the container:
docker run -d -p 5000:5000 --env-file .env gamingtools-backend
```

<a id="demo"></a>
## 🚀 Demo
#### Check out the live demo here ⬇️ :

https://collect-your-gamingtools.netlify.app/

<a id="installation"></a>
## 🛠️ Installation
#### To get started, simply clone the repository and open it in your browser:

Expand All @@ -110,7 +125,7 @@ https://collect-your-gamingtools.netlify.app/
xdg-open index.html # On Linux
```


<a id="contributing"></a>
## 🤝 Contributing
Contributions are what make the **open-source** community such an amazing place to learn, inspire, and create. Here’s how you can contribute:

Expand All @@ -126,6 +141,7 @@ Contributions are what make the **open-source** community such an amazing place

We welcome all contributions to improve **Collect Your GamingTools**! If you'd like to contribute, please follow the [Contributing.md](./Contributing.md) to get details on how to get started.

<a id="team"></a>
## 👥 Team

| ![Swaraj Das](https://avatars.githubusercontent.com/u/151845349?v=4&s=80) | ![Anit Sarkar](https://avatars.githubusercontent.com/u/135215478?v=4&s=80) |
Expand All @@ -142,6 +158,7 @@ We welcome all contributions to improve **Collect Your GamingTools**! If you'd l

![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)

<a id="contributors"></a>
## 🙌 Contributors

![GitHub contributors](https://img.shields.io/github/contributors/swaraj-das/Collect-your-GamingTools)
Expand Down