Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 1.43 KB

README.md

File metadata and controls

62 lines (40 loc) · 1.43 KB
Raw

[Demo Name Here]

[Small description of your demo here]

Where MongoDB Shines?

[Small explanation of which MongoDB features are present]

Learn more about MongoDB here.

High Level Architecture

[High level architecture diagram here use google slides]

Tech Stack

[List your tech stack]

[Example below]

Prerequisites

Before you begin, ensure you have met the following requirements:

  • Node.js 14 or higher

[Add more if needed]

Run it locally

  1. Navigate to the src folder.
  2. Install dependencies by running:
npm install
  1. Start the frontend development server with:
npm run dev
  1. The frontend will now be accessible at http://localhost:3000 by default, providing a user interface.

Run with Docker

Make sure to run this on the root directory.

  1. To run with Docker use the following command:
make build
  1. To delete the container and image run:
make clean

Common errors

  • Check that you've created an .env.local file that contains your valid (and working) API keys, environment and index variables.