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

  git clone https://github.com/GauravOOO2/help-center-assignment.git

Back End:

Navigate to the BackEnd Directory:

  cd help-center-assignment/BackEnd

Install dependencies

  npm install

Set Environment Variables:

Create a ".env" file in the backend directory and add the following:

MONGO_URI=<your-mongodb-connection-string>
PORT=5000

Start the BackEnd server

  node server.js

Front End:

Navigate to the Front End Directory:

  cd help-center-assignment/my-help-center

Install dependencies

  npm install

Set Environment Variables:

Create a .env file in the frontend directory and add the following:

NEXT_PUBLIC_BACKEND_URL="http://localhost:5000/api"

Run the Application

  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.

ThankYou.