Skip to content

This is a boilerplate designed to serve as robust template for quickly starting development on a Typescript based MERN web application.

Notifications You must be signed in to change notification settings

hack4impact-upenn/box-of-balloons

Repository files navigation

Boilerplate

This is a simple boilerplate designed to serve as robust template for quickly starting development on a Typescript based MERN web application.

Features

Required tools

These are necessary to build and run the project at full functionality

Recommended tools

To take full advantage of the linting/formatting, we recommend adding the Prettier and ESLint VSCode extensions and configuring them as shown here for code highlighting and formatting on save. Skip to the section labeled "Add the following to your VS Code settings.json". To access your settings.json, follow what is linked here. See here for the differences between the two tools and how they work together.

Finally, we also recommend downloading the Live Share extension by Microsoft for improved Collaboration. This allows for easy peer programming on one shared repository instance.

Setup

MongoDB

The boilerplate uses MongoDB as the database to store information for authentication. To have this available for use, do the following

Recommend downloading MongoDB Compass for easy viewing and management of data.

SendGrid

The boilerplate uses SendGrid to send emails to users in order to verify their account, and also to reset their passwords. To have email functionality available for use, the PM/TL should do the following

Mixpanel

Mixpanel is an analytics tool that helps us collect data on how users use our applications. To set up Mixpanel:

  • Create a Mixpanel account
  • Create a project (there may be one created by default)
  • Go to Settings (top-right) > Project Settings
  • Look for "Project Token"

Environment Variables

Create a file named .env in the root of the server folder and add the following variables with the appropriate values. PM/TLs should provide this to their developers.

ATLAS_URI=mongodb-connection-uri-from-above
COOKIE_SECRET=any-string
SENDGRID_API_KEY=sendgrid-api-key-from-above
SENDGRID_EMAIL_ADDRESS=sendgrid-sender-identity-email-from-above
MIXPANEL_TOKEN=mixpanel-token-from-above

Usage

NOTE: Currently, this project is best supported by running CLI commands from a bash/zsh environment. If using Windows, this can be achieved by following what's done here.

Installing dependencies

From the root folder, run the following to configure the project and its dependencies

$ yarn setup

If there is any need to reset the dependencies, simply run the following series of commands

$ yarn clean
$ yarn setup

Running the project

To run the project, use the following commands from the root folder

# run both server and client
$ yarn dev
# run server only
$ yarn server
# run client only
$ yarn client

Running tests

To run all the tests in the project, run the following from the root folder

$ yarn test

Running linting/formatting

To check for linting issues from ESLint and fix what's possible, from the root folder run the following

$ yarn lint

To format the code appropriately with Prettier (don't need this if format on save was setup in VSCode), from the root folder run the following

$ yarn format

Deployment (WIP)

The boilerplate is designed to be easily deployed on AWS ECS using Terraform.

You will need to install Terraform first. For Mac users, we recommend following the Homebrew installation.

You will then need to create a file called .auto.tfvars, and you can follow the format as in the .auto.tfvars.example file. Variables in here correspond to the same environment variables in the server folder, except for aws_account_id which is the account ID for your AWS account (can be found by clicking your username in the top-right of the AWS console).

To deploy, run

./deploy.sh

To tear down all infrastructure, run

terraform destroy

Due to the new (as of early 2024) nature of this AWS configuration, if you are encountering issues with deploying the project on AWS, then please use the old boilerplate and deploy on Heroku or another cloud platform as we have done in the past.

Setting Up Datadog

Datadog allows for post-deployment logs and traces. Here is a guide to set it up.

  1. Create a Datadog account.

  2. Add environment variables to the env file.

DD_AGENT_MAJOR_VERSION=7
DD_API_KEY=<key>
DD_SITE="us5.datadoghq.com"
DD_ENV=<project_name>
DD_LOGS_INJECTION=true
DD_TRACE_AGENT_URL=http://localhost:4000

In Datadog Agent, search “API Keys” and generate a New Key. Use the key to paste into Name your DD_ENV in <project_name>. This will be useful when querying logs.

  1. If not already installed, install the following dependencies.
npm install --save dd-trace
npm install winston
  1. The configDatadog.ts file exports three variables: loggerInfo, loggerWarn , and loggerError. These variables represent different log statuses. Simply add one of these log variables within each function in the format below.
loggerInfo.log('Account Verified');
loggerWarn.warn('Logger Initialized');
loggerError.error('Logout');

Some examples are shown in login() and logout() functions in auth.controller.ts.

  1. Access "Logs" in Datadog Agent and search "env:<project_name>" to find the logs and their timeline.

Common Problems

Fill in with problem scenario + solution as they arise

Incorrect Node Version

If you see an error message similar to this one:

The engine "node" is incompatible with this module. Expected version ">=12.0.0". Got "11.15.0"

or this one:

error [email protected]: The engine "node" is incompatible with this module. Expected version ">=18". Got "16.20.2"

This means you are using the wrong node version. This boilerplate relies on using node version 18.18.2. If you are using any other version of node, please use nvm to set node version to 18.18.2 as referenced here.

About

This is a boilerplate designed to serve as robust template for quickly starting development on a Typescript based MERN web application.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages