Skip to content

Web app for Achieve Now, a Philadelphia-based literacy nonprofit

Notifications You must be signed in to change notification settings

hack4impact-upenn/achieve-now

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, 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

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

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 lintint/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

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"

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

About

Web app for Achieve Now, a Philadelphia-based literacy nonprofit

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages