template/README.md

117 lines
6.3 KiB
Markdown
Raw Normal View History

2023-08-02 17:28:10 -04:00
<!-- Header -->
<div id="top" align="center">
<br />
<!-- Logo -->
2023-08-02 19:56:50 -04:00
<img src="https://git.zakscode.com/repo-avatars/2b4ee6ba1f2e2618bf7694e4a52fb56d1d0ea6abafa2dcbe496ab786b86d5a76" alt="Logo" width="200" height="200">
2023-08-02 17:28:10 -04:00
<!-- Title -->
### Template
<!-- Description -->
Simple repository template
<!-- 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)
<!-- Links -->
2023-08-02 20:03:56 -04:00
---
<div>
<a href="https://git.zakscode.com/ztimson/template/wiki" target="_blank">Documentation</a>
2023-08-02 17:28:10 -04:00
<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>
2023-08-02 20:03:56 -04:00
<a href="https://git.zakscode.com/ztimson/template/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
2023-08-02 17:28:10 -04:00
</div>
2023-08-02 20:03:56 -04:00
---
2023-08-02 17:28:10 -04:00
</div>
2023-08-01 10:58:47 -04:00
## Table of Contents
2023-08-02 17:28:10 -04:00
- [Template](#top)
2023-08-07 13:06:52 -04:00
- [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)
- [Built With](#built-with)
- [Demo](#demo)
- [Setup](#setup)
- [Production](#production)
- [Development](#development)
- [License](#license)
2023-08-02 17:28:10 -04:00
## 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.
2023-08-01 10:58:47 -04:00
2023-08-07 12:33:39 -04:00
### Built With
2023-08-07 12:22:34 -04:00
[![.NET](https://img.shields.io/badge/.NET-512BD4?style=for-the-badge&logo=dotnet)](https://dotnet.microsoft.com/)
2023-08-07 11:59:28 -04:00
[![Angular](https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular)](https://angular.io/)
2023-08-07 12:22:34 -04:00
[![Arduino](https://img.shields.io/badge/Arduino-00878F?style=for-the-badge&logo=arduino&logoColor=white)](https://www.arduino.cc/)
2023-08-07 11:59:28 -04:00
[![Bootstrap](https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white)](https://getbootstrap.com)
2023-08-07 12:22:34 -04:00
[![C](https://img.shields.io/badge/C-A8B9CC?style=for-the-badge&logo=c&logoColor=ffffff)](https://en.cppreference.com/w/c/language)
[![C++](https://img.shields.io/badge/C%2B%2B-00599C?style=for-the-badge&logo=cplusplus)](https://cplusplus.com/)
[![C#](https://img.shields.io/badge/C%23-239120?style=for-the-badge&logo=csharp)](https://dotnet.microsoft.com/)
2023-08-07 11:59:28 -04:00
[![Docker](https://img.shields.io/badge/Docker-384d54?style=for-the-badge&logo=docker)](https://docker.com/)
2023-08-07 12:22:34 -04:00
[![Firebase](https://img.shields.io/badge/Firebase-FFFFFF?style=for-the-badge&logo=firebase)](https://firebase.google.com/)
[![HTML](https://img.shields.io/badge/HTML-FFFFFF?style=for-the-badge&logo=html5)](https://developer.mozilla.org/en-US/docs/Glossary/HTML)
[![Java](https://img.shields.io/badge/Java-5382A1?style=for-the-badge&logo=coffeescript&logoColor=F8981D)](https://java.com/)
[![JavaScript](https://img.shields.io/badge/JavaScript-000000?style=for-the-badge&logo=javascript)](https://javascript.com/)
[![JQuery](https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery)](https://jquery.com )
[![Laravel](https://img.shields.io/badge/Laravel-6C6C6C?style=for-the-badge&logo=laravel)](https://laravel.com)
[![Next](https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs)](https://nextjs.org/)
[![Nest](https://img.shields.io/badge/nestjs-E0234E?style=for-the-badge&logo=nestjs)](https://nestjs.com/)
2023-08-07 11:59:28 -04:00
[![Node](https://img.shields.io/badge/Node.js-000000?style=for-the-badge&logo=nodedotjs)](https://nodejs.org/)
2023-08-07 12:22:34 -04:00
[![PHP](https://img.shields.io/badge/PHP-474A8A?style=for-the-badge&logo=php&logoColor=white)](https://www.php.net/)
[![Python](https://img.shields.io/badge/Python-FFD43B?style=for-the-badge&logo=python)](https://www.python.org/)
[![React](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react)](https://reactjs.org/)
[![Shell](https://img.shields.io/badge/Shell-000000?style=for-the-badge&logo=windowsterminal&logoColor=00ff00)](https://en.wikipedia.org/wiki/Shell_script)
[![Svelte](https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte)](https://svelte.dev/)
2023-08-07 11:59:28 -04:00
[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/)
2023-08-07 12:22:34 -04:00
[![Vue](https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs)](https://vuejs.org/)
2023-08-02 20:03:56 -04:00
# Demo
Website: https://git.zakscode.com
2023-08-01 10:58:47 -04:00
## Setup
2023-08-02 17:28:10 -04:00
2023-08-01 10:58:47 -04:00
<details>
<summary>
2023-08-02 17:28:10 -04:00
<h3 id="production" style="display: inline">
Production
2023-08-01 10:58:47 -04:00
</h3>
</summary>
#### Prerequisites
2023-08-02 17:28:10 -04:00
- [Docker](https://docs.docker.com/install/)
2023-08-01 10:58:47 -04:00
#### Instructions
2023-08-02 17:28:10 -04:00
1. Run the docker image: `docker run -p 80:80 git.zakscode.com/ztimson/template:latest`
2. Open [http://localhost](http://localhost)
2023-08-01 10:58:47 -04:00
</details>
<details>
<summary>
2023-08-02 17:28:10 -04:00
<h3 id="development" style="display: inline">
Development
2023-08-01 10:58:47 -04:00
</h3>
</summary>
#### Prerequisites
2023-08-02 17:28:10 -04:00
- [Node.js](https://nodejs.org/en/download)
2023-08-01 10:58:47 -04:00
#### Instructions
2023-08-02 17:28:10 -04:00
1. Install the dependencies: `npm install`
2. Start the Angular server: `npm run start`
3. Open [http://localhost:4200](http://localhost:4200)
2023-08-01 10:58:47 -04:00
2023-08-02 17:28:10 -04:00
</details>
2023-08-01 10:58:47 -04:00
2023-08-02 17:28:10 -04:00
## License
2023-08-07 12:26:43 -04:00
Copyright © 2023 Zakary Timson | All Rights Reserved | Available under MIT Licensing
2023-08-01 10:58:47 -04:00
2023-08-02 17:28:10 -04:00
See the [license](./LICENSE) for more information.