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

Update README.md #716

Merged
merged 2 commits into from
Nov 1, 2024
Merged
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
56 changes: 50 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,21 +33,65 @@ A <b> responsive and dynamic website </b> to showcase the best gaming accessorie



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

## 💻 Technologies Used ( Backend & Docker Functionality )

## 🚀 Demo
#### Check out the live demo here ⬇️ :
- 🟢 **Node.js** and **Express** for the backend
- 🍃 **MongoDB** for database storage
- 🐳 **Docker** for containerization

https://collect-your-gamingtools.netlify.app/
<p align="center">
<a href="https://skillicons.dev">
<img src="https://skillicons.dev/icons?i=nodejs,express,mongodb,docker" alt="Node.js, Express, MongoDB, Docker" />
</a>
</p>

## ⚙️ Backend Setup
1. Clone the repository:
```bash
git clone https://github.com/username/collect-your-gamingtools.git
```

2. Install dependencies:
```bash
cd collect-your-gamingtools
npm install
```

3. Configure environment variables:
Create a .env file with:
```bash
MONGO_URI=your_mongodb_uri
JWT_SECRET=your_jwt_secret
PORT=5000
```

4. Start the server:
```bash
npm start
```

## 🐳 Docker
Build the Docker image:
```bash
docker build -t gamingtools-backend .
```

Run the container:
```bash
docker run -d -p 5000:5000 --env-file .env gamingtools-backend
```

## 🚀 Demo
#### Check out the live demo here ⬇️ :

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

## 🛠️ Installation
#### To get started, simply clone the repository and open it in your browser:
Expand Down