Update README.md
This commit is contained in:
parent
15f27dc519
commit
9cbca78d3b
111
README.md
111
README.md
@ -1,48 +1,56 @@
|
|||||||
# Template Name
|
<!-- Header -->
|
||||||
<!-- Logo prefered -->
|
<div id="top" align="center">
|
||||||
<!-- ![]() -->
|
<br />
|
||||||
<!-- --- -->
|
|
||||||
|
<!-- Logo -->
|
||||||
|
<img src="./logo.png" alt="Logo" width="200" height="200">
|
||||||
|
|
||||||
Short description
|
<!-- Title -->
|
||||||
|
### Template
|
||||||
|
|
||||||
|
<!-- Description -->
|
||||||
|
Simple repository template
|
||||||
|
|
||||||
<!-- Any badges -->
|
<!-- Repo badges -->
|
||||||
|
[![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/template/tags&query=$[0].name)](https://git.zakscode.com/ztimson/template/tags)
|
||||||
|
[![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/template&query=open_pr_counter)](https://git.zakscode.com/ztimson/template/pulls)
|
||||||
|
[![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/template&query=open_issues_count)](https://git.zakscode.com/ztimson/template/issues)
|
||||||
|
|
||||||
<!-- Screenshot -->
|
<!-- Tech Badges -->
|
||||||
<!-- ![]() -->
|
[![Angular](https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular)](https://angular.io/)
|
||||||
|
[![Bootstrap](https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white)](https://getbootstrap.com)
|
||||||
|
[![Docker](https://img.shields.io/badge/Docker-384d54?style=for-the-badge&logo=docker)](https://docker.com/)
|
||||||
|
[![Node](https://img.shields.io/badge/Node.js-000000?style=for-the-badge&logo=nodedotjs)](https://nodejs.org/)
|
||||||
|
[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/)
|
||||||
|
|
||||||
Long desciption
|
<!-- Links -->
|
||||||
|
<div align="center">
|
||||||
|
<a href="https://git.zakscode.com" target="_blank">Demo</a>
|
||||||
|
• <a href="https://git.zakscode.com/ztimson/template/wiki" target="_blank">Documentation</a>
|
||||||
|
• <a href="https://git.zakscode.com/ztimson/template/releases" target="_blank">Release Notes</a>
|
||||||
|
• <a href="https://git.zakscode.com/ztimson/template/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
|
||||||
|
• <a href="https://git.zakscode.com/ztimson/template/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
- [Template Name](#template-name)
|
- [Template](#top)
|
||||||
- [Table of Contents](#table-of-contents)
|
- [Demo](https://git.zakscode.com)
|
||||||
- [Stack](#stack)
|
- [Documentation](https://git.zakscode.com/ztimson/template/wiki)
|
||||||
- [Setup](#setup)
|
- [Release Notes](https://git.zakscode.com/ztimson/template/releases)
|
||||||
- [Development](#development)
|
- [Report a Bug](https://git.zakscode.com/ztimson/template/issues/new?template=.github%2fissue_template%2fbug.md)
|
||||||
- [Production](#production)
|
- [Feature Request](https://git.zakscode.com/ztimson/template/issues/new?template=.github%2fissue_template%2fenhancement.md)
|
||||||
- [Cheatsheet](#cheatsheet)
|
- [About](#about)
|
||||||
|
- [Setup](#setup)
|
||||||
|
- [Production](#production)
|
||||||
|
- [Development](#development)
|
||||||
|
- [License](#license)
|
||||||
|
|
||||||
## Stack
|
## About
|
||||||
| Technology | Version |
|
|
||||||
|------------|---------|
|
|
||||||
| | |
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
<details>
|
|
||||||
<summary>
|
|
||||||
<h3 id="development" style="display: inline">
|
|
||||||
Development
|
|
||||||
</h3>
|
|
||||||
</summary>
|
|
||||||
|
|
||||||
#### Prerequisites
|
|
||||||
- ...
|
|
||||||
|
|
||||||
#### Instructions
|
|
||||||
1. ...
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>
|
<summary>
|
||||||
@ -52,20 +60,31 @@ Long desciption
|
|||||||
</summary>
|
</summary>
|
||||||
|
|
||||||
#### Prerequisites
|
#### Prerequisites
|
||||||
- ...
|
- [Docker](https://docs.docker.com/install/)
|
||||||
|
|
||||||
#### Instructions
|
#### Instructions
|
||||||
1. ...
|
1. Run the docker image: `docker run -p 80:80 git.zakscode.com/ztimson/template:latest`
|
||||||
|
2. Open [http://localhost](http://localhost)
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
## Cheatsheet
|
<details>
|
||||||
```bash
|
<summary>
|
||||||
# Start redis
|
<h3 id="development" style="display: inline">
|
||||||
docker-compose up redis
|
Development
|
||||||
|
</h3>
|
||||||
|
</summary>
|
||||||
|
|
||||||
# Start server
|
#### Prerequisites
|
||||||
cd api && npm run start
|
- [Node.js](https://nodejs.org/en/download)
|
||||||
|
|
||||||
# Start website
|
#### Instructions
|
||||||
cd website && npm run dev
|
1. Install the dependencies: `npm install`
|
||||||
```
|
2. Start the Angular server: `npm run start`
|
||||||
|
3. Open [http://localhost:4200](http://localhost:4200)
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
## License
|
||||||
|
Copyright © 2023 Zakary Timson | All Rights Reserved
|
||||||
|
|
||||||
|
See the [license](./LICENSE) for more information.
|
||||||
|
Loading…
Reference in New Issue
Block a user