From b49d6fa9ff25fe10077a02644694129705275d05 Mon Sep 17 00:00:00 2001 From: Zakary Timson Date: Tue, 1 Aug 2023 14:58:47 +0000 Subject: [PATCH] Update README.md --- README.md | 72 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 70 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b683fb2..49b190f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,71 @@ -# template +# Template Name + + + -Simple template -- no code \ No newline at end of file +Short description + + + + + + +Long desciption + +## Table of Contents +- [Template Name](#template-name) + - [Table of Contents](#table-of-contents) + - [Stack](#stack) + - [Setup](#setup) + - [Development](#development) + - [Production](#production) + - [Cheatsheet](#cheatsheet) + +## Stack +| Technology | Version | +|------------|---------| +| | | + +## Documentation + + +## Setup +
+ +

+ Development +

+
+ +#### Prerequisites +- ... + +#### Instructions +1. ... +
+ +
+ +

+ Production +

+
+ +#### Prerequisites +- ... + +#### Instructions +1. ... +
+ +## Cheatsheet +```bash +# Start redis +docker-compose up redis + +# Start server +cd api && npm run start + +# Start website +cd website && npm run dev +```