Admin Dashboard

This repo is for the s4yt admin dashboard.

MERN Project with Embedded Client (Vite)

This is a MERN stack project where the React client is embedded inside the views/ folder and runs using Vite.

🚀 Project Structure

/project-root
├# Express server (Node.js)
│── models/         # Mongoose models
│── routes/         # API routes
│── controllers/    # Business logic
│── index.js        # Entry point for the backend
│── package.json    # Backend dependencies
│
├── views/              # Embedded React app (Vite)
│   ├── src/            # React source files
│   ├── public/         # Static assets
│   ├── index.html      # React entry point
│   ├── vite.config.js  # Vite configuration
│   ├── .env            # Environment variables
│   ├── package.json    # Frontend dependencies
│
├── .env                # Environment variables
├── README.md           # Project documentation

---

🛠️ Setup Instructions

1️⃣ Clone the Repository

git clone <repo-url>

2️⃣ Install Dependencies

🔹 Backend

cd backend
npm install

🔹 Frontend (Vite React)

cd ./views
npm install

---

🚀 Running the Project

Start the Backend Server

npm run dev

• Runs the Express server on http://localhost:5000

Start the Vite Frontend

cd ./views
npm run dev

• Runs the client on http://localhost:3000

---

S4YT Dashboard API Documentation

This documentation provides the details of the API endpoints for the S4YT Admin Panel.

API Endpoints

1. POST /api/login

• Description: This endpoint allows an admin to log in.
• URL: http://localhost:4000/api/login
• Request Body (URL Encoded):
  • email: tester1@test.com
  • password: 123

Example Request:

POST http://localhost:4000/api/login
Content-Type: application/x-www-form-urlencoded
email=tester1@test.com&password=123

---

2. POST /api/register

• Description: This endpoint allows a new business to register.
• URL: http://localhost:4000/api/register
• Request Body (URL Encoded):
  • businessName:
  • email:
  • password:

Example Request:

POST http://localhost:4000/api/register
Content-Type: application/x-www-form-urlencoded
businessName=tester2&email=tester2@test.com&password=123

---

3. GET /api/business/{businessId}

• Description: This endpoint allows fetching a specific business's details by its ID.
• URL: http://localhost:4000/api/business/67ab86a627a0afca404537c3
• Request: GET
• Example Request:

GET http://localhost:4000/api/business/67ab86a627a0afca404537c3

---

4. PUT /api/business/{businessId}

• Description: This endpoint allows updating the business details.
• URL: http://localhost:4000/api/business/:id
• Request Body (URL Encoded):
  • description:
  • logo:
  • question:
  • youtubeLink:

Example Request:

PUT http://localhost:4000/api/business/:id
Content-Type: application/x-www-form-urlencoded
description=a+test+business+for+an+example&logo=test&question=sample+question&youtubeLink=link

---

5. DELETE /api/business/{businessId}

• Description: This endpoint allows deleting a specific business.
• URL: http://localhost:4000/api/business/:id
• Request: DELETE

Example Request:

DELETE http://localhost:4000/api/business/:id

---

6. GET /api/admin/businesses

• Description: This endpoint fetches all businesses.
• URL: http://localhost:4000/api/admin/businesses
• Request: GET

Example Request:

GET http://localhost:4000/api/business/:id

---

7. POST /api/raffle-item

• Description: This endpoint creates a new raffle item.
• URL: http://localhost:4000/api/raffle-item
• Request: POST

Example Request:

POST http://localhost:4000/api/raffle-item

---

8. PUT /api/raffle-item/{itemId}

• Description: This endpoint modifies information about a raffle item located by its ID.
• URL: http://localhost:4000/api/raffle-item/:id
• Request: PUT

Example Request:

PUT http://localhost:4000/api/raffle-item/:id

---

9. DELETE /api/raffle-item/{itemId}

• Description: This endpoint deletes a raffle item located by its ID.
• URL: http://localhost:4000/api/raffle-item/:id
• Request: DELETE

Example Request:

DELETE http://localhost:4000/api/raffle-item/:id

---

10. PUT /api/manage-coins/{userId}

• Description: This endpoint allows modification of a user's coin total located by their user ID.
• URL: http://localhost:4000/api/manage-coins/:id
• Request: PUT

Example Request:

PUT http://localhost:4000/api/manage-coins/:id

---

11. PUT /api/kick-user/{userId}

• Description: This endpoint allows the admin to kick a user based on their user ID.
• URL: http://localhost:4000/api/kick-user/:id
• Request: PUT

Example Request:

PUT http://localhost:4000/api/kick-user/:id

---

12. PUT /api/ban-user/{userId}

• Description: This endpoint allows the admin to ban a user (located with their ID) for a specific time period.
• URL: http://localhost:4000/api/ban-user/:id
• Request: PUT

Example Request:

PUT http://localhost:4000/api/ban-user/:id

---

13. GET /api/users

• Description: This endpoint allows fetching information about all users in the database.
• URL: http://localhost:4000/api/users
• Request: GET
• Example Request:

GET http://localhost:4000/api/users

---

14. GET /api/raffle-partners

• Description: This endpoint allows fetching information about all raffle partners in the database.
• URL: http://localhost:4000/api/raffle-partners
• Request: GET
• Example Request:

GET http://localhost:4000/api/raffle-partners

---

15. POST /api/raffle-partner

• Description: This endpoint allows creating a new raffle partner.
• URL: http://localhost:4000/api/raffle-partner
• Request: POST
• Example Request:

POST http://localhost:4000/api/raffle-partner

---

16. PUT /api/raffle-partner/:id

• Description: This endpoint allows modifying an existing raffle partner.
• URL: http://localhost:4000/api/raffle-partner/:id
• Request: PUT
• Example Request:

PUT http://localhost:4000/api/raffle-partner/a1

---

17. DELETE /api/raffle-partner/:id

• Description: This endpoint allows deleting a raffle partner from the database.
• URL: http://localhost:4000/api/raffle-partner/:id
• Request: DELETE
• Example Request:

DELETE http://localhost:4000/api/raffle-partner/a1

---

18. GET /api/raffle-items

• Description: This endpoint allows fetching all raffle items in the database.
• URL: http://localhost:4000/api/raffle-items
• Request: GET
• Example Request:

GET http://localhost:4000/api/raffle-items

---