richardhpa/mongodb-atlas-hackathon

MongoDB-Atlas-Hackathon

Project for MongoDB Atlas Hackathon on DEV!

Installation

Config

This project uses MongoDB to manage the backend database. So you will either need a MongoDB Atlas account, or MongoDB installed locally on your machine.

Create a .env file in the root directory with the the following variables.

// Port you would like your server to run on
PORT=

// MongoDB details
MONGO_USER=
MONGO_PASSWORD=
MONGO_CLUSTER_NAME=
MONGO_TABLE_NAME=

// Mail service details
MAIL_USER=
MAIL_PASSWORD=
MAIL_HOST=
MAIL_PORT=
MAIL_FROM=

// Base url for the server
API_HOST=

There is an example provided in the project

For the mail variables it is recommended that you use ethereal while you are developing. This is a fake SMTP service which intercepts emails from nodemailer.

Install Dependencies & Run the Client & Server

There are a few command you can run for this project. Depending on what you would like to do is which one you should use.

# Install dependencies for server
npm run install:server

# Install dependencies for client
npm run install:client

# Run the client & server with concurrently
npm run dev

# Run the Express server only
npm run start:server

# Run the React client only
npm run start:client

mongodb-atlas-hackathon's Issues

Discuss design - look and feel of the leaderboard