From 9cbca78d3b49f64b5a66a3e23d09cd52d098aeb0 Mon Sep 17 00:00:00 2001 From: Zakary Timson Date: Wed, 2 Aug 2023 21:28:10 +0000 Subject: [PATCH] Update README.md --- README.md | 111 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 65 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 49b190f..73a2b87 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,56 @@ -# Template Name - - - + +
+
+ + + Logo -Short description + + ### Template + + + Simple repository template - + + [![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) - - + + [![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 + +
+ Demo + • Documentation + • Release Notes + • Report a Bug + • Request a Feature +
+
## Table of Contents -- [Template Name](#template-name) - - [Table of Contents](#table-of-contents) - - [Stack](#stack) - - [Setup](#setup) - - [Development](#development) - - [Production](#production) - - [Cheatsheet](#cheatsheet) +- [Template](#top) + - [Demo](https://git.zakscode.com) + - [Documentation](https://git.zakscode.com/ztimson/template/wiki) + - [Release Notes](https://git.zakscode.com/ztimson/template/releases) + - [Report a Bug](https://git.zakscode.com/ztimson/template/issues/new?template=.github%2fissue_template%2fbug.md) + - [Feature Request](https://git.zakscode.com/ztimson/template/issues/new?template=.github%2fissue_template%2fenhancement.md) +- [About](#about) +- [Setup](#setup) + - [Production](#production) + - [Development](#development) +- [License](#license) -## Stack -| Technology | Version | -|------------|---------| -| | | - -## Documentation +## About +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 -
- -

- Development -

-
- -#### Prerequisites -- ... - -#### Instructions -1. ... -
@@ -52,20 +60,31 @@ Long desciption #### Prerequisites -- ... +- [Docker](https://docs.docker.com/install/) #### Instructions -1. ... +1. Run the docker image: `docker run -p 80:80 git.zakscode.com/ztimson/template:latest` +2. Open [http://localhost](http://localhost)
-## Cheatsheet -```bash -# Start redis -docker-compose up redis +
+ +

+ Development +

+
-# Start server -cd api && npm run start +#### Prerequisites +- [Node.js](https://nodejs.org/en/download) -# Start website -cd website && npm run dev -``` +#### Instructions +1. Install the dependencies: `npm install` +2. Start the Angular server: `npm run start` +3. Open [http://localhost:4200](http://localhost:4200) + +
+ +## License +Copyright © 2023 Zakary Timson | All Rights Reserved + +See the [license](./LICENSE) for more information.