Update README.md

This commit is contained in:
Zakary Timson 2023-08-01 14:58:47 +00:00
parent 9117ad634e
commit b49d6fa9ff

View File

@ -1,3 +1,71 @@
# template # Template Name
<!-- Logo prefered -->
<!-- ![]() -->
<!-- --- -->
Simple template -- no code Short description
<!-- Any badges -->
<!-- Screenshot -->
<!-- ![]() -->
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
<details>
<summary>
<h3 id="development" style="display: inline">
Development
</h3>
</summary>
#### Prerequisites
- ...
#### Instructions
1. ...
</details>
<details>
<summary>
<h3 id="production" style="display: inline">
Production
</h3>
</summary>
#### Prerequisites
- ...
#### Instructions
1. ...
</details>
## Cheatsheet
```bash
# Start redis
docker-compose up redis
# Start server
cd api && npm run start
# Start website
cd website && npm run dev
```