README.md

This description should convey the essential information to the user.
For example; answer:

- Where is the app currently hosted?
- What stack is the app using?
- Location of project docs

# Setup

Prerequisites:

- Windows, Mac or Linux
- Node v16.4.0 or greater
- Safari v15.5

Installation:

1. Run `npm install`
2. `npm run dev` to host at localhost:3000
3. `npm run test:unit` to run the test suite

Deployment:

1. `npm run build` to build to dist/
2. `serverless deploy` to deploy to the cloud

# App Details

The main section with in-depth explanations of the app components.

This could include things like:

- Architecture
- App features
- Data flow
- Related services
- Job queues
- Caching
- Cloud infrastructure
- etc

SPEC.md

# Project name

01 January 1970

Project Links:

Links to repos, design files, other docs etc.

## The problem

Summary:

- Problem statement description

Goals:

- What are the main pain points in the problem?

Out of scope:

- What will be out of scope for the proposed solution?

## The solution

Overview:

- How will we solve the project Goals?

System context diagram - very abstract diagram of system interactions

Systems:

- Detail any subsystems - eg mobile app, webapp
- Detail any external systems - eg integrations

Non-functional considerations:

- Scalability, performance
- Security & how are we handling user data?
- Data recovery processes
- Consider globalisation - eg GDPR if the app is available in EU

## Operations

Deployment:

- Where will the app(s) be deployed?
- How much will it cost per day / week / month?
- Will we have a separate staging environment?

Release plan:

- Will we release to all users at once?
- Will any other systems be affected?