Typescript MERN starter

Contents

1. Overview
2. Installation
   • Docker
   • Localhost
3. Packages
   • Backend
   • Database todo
   • Frontend
4. Releases todo
5. Deployment todo
6. Versioning todo

Overview

This repo contains all of the core software and deployment pipelines. This document aims to give a high level overview of our software architecture as well as the authors notes on the design and structure of this repository. Instead of having several smaller repositories for the requisite components, we're utilizing a mono-repo structure using Lerna project.

Installation

Docker

todo: maybe setup a makefile to execute docker commands

Localhost (W/O Docker)

# start off by cd'ing into the backend
cd packages/backend

## Backend (in fresh term)
npm i

# watch typescript
npm run watch

# spin up the backend
npm run dev

## Frontend (in fresh term)

npm i

# spin up the frontend
cd packages/frontend

npm run start

Commit and Versioning

# commit
npm run commit

# version
npm run version

Packages

Backend

Mongo, Express and Typescript

Database

todo : separate?

Frontend

CRA --typescript