72 lines
989 B
Markdown
72 lines
989 B
Markdown
# Template Name
|
|
<!-- Logo prefered -->
|
|
<!-- ![]() -->
|
|
<!-- --- -->
|
|
|
|
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
|
|
```
|