Table of Contents

Planner V2

Overview

The second iteration of Planner4You.

Style guide

TBA

Planner V2 Structure

App Structure Overview

Both the frontend and backend are programmed in Typescript; Typescript is a type safe, and more structured varient of the javascript lanugage (ES6/ES12-ES2021). We use Yarn on the frontend and backend also, to install packages and run a local development server.

A GraphQL server is used in the backend, to provide structured and secure access to the data in our Database. We've not currently chosen a server to serve the backend code to the client, therefore, the project only works locally from development enviroments.

Our database is implemented in Postgres, which is a relational database that uses SQL.

Frontend

Backend

Libraries

GraphQL (Apollo)

We use Apollo GraphQL as our implementation of GraphQL. (Tutorial here)

cross-env

cross-env is used for setting the environment mode the project is run in, in a OS independant way. It is used in the package.json file.

blipp is a simple hapi plugin to display the routes table to console at startup.

Database

We're Using a postgress database

ERD cardinality key

TBA

Database ERD

TBA

Project setup and Build

TBA

Potential build issues, and their fixes

Deploy a build live