https://github.com/gauravooo2/help-center-assignment-backend
https://github.com/gauravooo2/help-center-assignment-backend
Last synced: 29 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/gauravooo2/help-center-assignment-backend
- Owner: GauravOOO2
- Created: 2024-09-08T16:53:17.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-08T17:03:33.000Z (almost 2 years ago)
- Last Synced: 2025-02-25T17:37:09.589Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://help-center-assignment-backend.vercel.app
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
##### Here's the updated README file for Help Center API Assignment:
---
# Help Center API Assignment
### Description
The Help Center Cards API is a service designed to manage 'Help Center' cards, allowing users to effortlessly create and read cards to provide information or raise doubts.
It provides functionalities such as form submissions and search capabilities to enhance user interaction and management of help center content.
---
## Technology Stack
- **Next.js:** Used for the frontend application to interact with the API, including form submissions and displaying search results.
- **MongoDB:** Provides a NoSQL database to store and manage 'Help Center' card data.
- **Node.js:** Used as the runtime environment for building the server-side application.
- **Express:** Serves as the web application framework to handle HTTP requests and responses, and manage API routes.
- **Tailwind CSS:** A utility-first CSS framework for building custom designs quickly.
- **CORS:** Configured to handle cross-origin requests between the frontend and backend.
---
## Run Locally
#### Clone the project from github
```bash
git clone https://github.com/GauravOOO2/help-center-assignment.git
```
**Back End:**
Navigate to the BackEnd Directory:
```bash
cd help-center-assignment/BackEnd
```
Install dependencies
```bash
npm install
```
Set Environment Variables:
Create a ".env" file in the backend directory and add the following:
```bash
MONGO_URI=
PORT=5000
```
Start the BackEnd server
```bash
node server.js
```
**Front End:**
Navigate to the Front End Directory:
```bash
cd help-center-assignment/my-help-center
```
Install dependencies
```bash
npm install
```
Set Environment Variables:
Create a .env file in the frontend directory and add the following:
```bash
NEXT_PUBLIC_BACKEND_URL="http://localhost:5000/api"
```
Run the Application
```bash
npm run dev
```
### Note: Please add your MongoDB link in the .env folder at the place "MONGO_URI="
## Built by
This project is built by [J.Gaurav Varma](https://github.com/GauravOOO2).
ThankYou.
---