Compare commits
41 Commits
5f354ab3e2
...
develop
Author | SHA1 | Date | |
---|---|---|---|
c38eeace5a | |||
3c2386b964 | |||
e0836387a2 | |||
0abbb76076 | |||
45a6200ba0 | |||
54c613efc3 | |||
03c93b87f7 | |||
01ba1dd424 | |||
1cb2492791 | |||
81339ef865 | |||
e10eb5ca3a | |||
c1bdcbbc14 | |||
6cd8e7d0ee | |||
053005975f | |||
e69e9089bb | |||
d12def11aa | |||
5dc18911ec | |||
24c1b800e0 | |||
98df38f4b9 | |||
21670c1b16 | |||
ca4e95fba9 | |||
31f75c6d09 | |||
d97233e354 | |||
84b638f339 | |||
c9fccfc13c | |||
4d301ce22a | |||
04ac866498 | |||
aed083a1b2 | |||
81322f881f | |||
b75ebfb88a | |||
83cb3486bb | |||
6e0737836e | |||
03e3d275cb | |||
adfc5e984e | |||
624755bdd2 | |||
9cbca78d3b | |||
15f27dc519 | |||
2e143727f2 | |||
aeb84c5b8e | |||
9bdafda2a7 | |||
1bed932cf4 |
16
.editorconfig
Normal file
16
.editorconfig
Normal file
@ -0,0 +1,16 @@
|
||||
# Editor configuration, see https://editorconfig.org
|
||||
root = true
|
||||
|
||||
[*]
|
||||
charset = utf-8
|
||||
indent_style = tab
|
||||
indent_size = 4
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
|
||||
[*.ts]
|
||||
quote_type = single
|
||||
|
||||
[*.md]
|
||||
max_line_length = off
|
||||
trim_trailing_whitespace = false
|
32
.github/issue_template/bug.md
vendored
32
.github/issue_template/bug.md
vendored
@ -1,34 +1,30 @@
|
||||
# Bug Report
|
||||
---
|
||||
|
||||
name: "Bug report"
|
||||
about: "Encountered an issue"
|
||||
ref: "develop"
|
||||
labels:
|
||||
- Type/Bug
|
||||
|
||||
---
|
||||
|
||||
# Bug Report
|
||||
<!-- Description of problem -->
|
||||
I tried to ...
|
||||
|
||||
But instead ...
|
||||
|
||||
## Steps to Reproduce
|
||||
<!-- How can developers replicate & test the problem? -->
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
## Logs
|
||||
<!-- Any logs that accompenied the error -->
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
## Tasks
|
||||
- [ ] Vetted by business
|
||||
- [ ] Prioritized & approved by PO
|
||||
- [ ] Refined
|
||||
- [ ] Assigned an Epic
|
||||
- [ ] Broken down into dev tasks
|
||||
- [ ] Estimated wieght
|
||||
- [ ] Adjusted labels
|
||||
- Scope?
|
||||
- Requires QA testing? `QA`
|
||||
- Added `Workflow::Ready`
|
||||
- Remove `Refine`
|
||||
|
||||
<!-- DO NOT EDIT PAST HERE -->
|
||||
/relabel ~"Refine" ~"Type::Bug"
|
||||
<!-- Screenshots (annoted if possible) of the problem -->
|
||||
|
22
.github/issue_template/enhancment.md
vendored
Normal file
22
.github/issue_template/enhancment.md
vendored
Normal file
@ -0,0 +1,22 @@
|
||||
---
|
||||
|
||||
name: "Enhancement"
|
||||
about: "Request a feature"
|
||||
ref: "develop"
|
||||
labels:
|
||||
- Type/Enhancement
|
||||
|
||||
---
|
||||
|
||||
# Feature Request
|
||||
<!-- Detailed description -->
|
||||
...
|
||||
|
||||
## Requirements
|
||||
<!-- Bullet list of requirments -->
|
||||
1. ...
|
||||
2. ...
|
||||
|
||||
## Notes
|
||||
<!-- Any additional considerations, solutions or design choices -->
|
||||
...
|
26
.github/issue_template/refactor.md
vendored
Normal file
26
.github/issue_template/refactor.md
vendored
Normal file
@ -0,0 +1,26 @@
|
||||
---
|
||||
|
||||
name: "Refactor"
|
||||
about: "Refactor existing system"
|
||||
ref: "develop"
|
||||
labels:
|
||||
- Kind/Refactor
|
||||
|
||||
---
|
||||
|
||||
# Refactor
|
||||
<!-- Detailed description -->
|
||||
The current...
|
||||
|
||||
Should be changed/updated to...
|
||||
|
||||
## Reasoning
|
||||
- ...
|
||||
|
||||
## Scope
|
||||
<!-- What systems will this impact -->
|
||||
- ...
|
||||
|
||||
## Notes
|
||||
<!-- Any additional design considerations -->
|
||||
...
|
20
.github/pull_request_template.md
vendored
20
.github/pull_request_template.md
vendored
@ -1,17 +1,15 @@
|
||||
## Description
|
||||
<!-- Adition information & context -->
|
||||
|
||||
<!-- Addition information & context -->
|
||||
...
|
||||
|
||||
## Issues
|
||||
<!-- Issues this MR will address -->
|
||||
- owner/repo#___
|
||||
<!-- Issues this PR will address -->
|
||||
- closes #___
|
||||
- owner/repo#___
|
||||
|
||||
## Checklist
|
||||
<!-- Complete this checklist after creating the MR -->
|
||||
- [ ] Linked issues above
|
||||
- [ ] Reviewed your changes
|
||||
- [ ] Commented/documented changes
|
||||
|
||||
<!-- Don't edit -->
|
||||
/assign me
|
||||
<!-- Complete after creating PR -->
|
||||
- [ ] Linked issues
|
||||
- [ ] Reviewed changes
|
||||
- [ ] Updated comments/documentation
|
||||
|
1
CODEOWNERS
Normal file
1
CODEOWNERS
Normal file
@ -0,0 +1 @@
|
||||
* @ztimson
|
11
LICENSE
Normal file
11
LICENSE
Normal file
@ -0,0 +1,11 @@
|
||||
Copyright (c) 2023 Zakary Timson
|
||||
|
||||
All Rights Reserved.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
147
README.md
147
README.md
@ -1,48 +1,98 @@
|
||||
# Template Name
|
||||
<!-- Logo prefered -->
|
||||
<!-- ![]() -->
|
||||
<!-- --- -->
|
||||
<!-- Header -->
|
||||
<div id="top" align="center">
|
||||
<br />
|
||||
|
||||
<!-- Logo -->
|
||||
<img src="https://git.zakscode.com/repo-avatars/2b4ee6ba1f2e2618bf7694e4a52fb56d1d0ea6abafa2dcbe496ab786b86d5a76" alt="Logo" width="200" height="200">
|
||||
|
||||
Short description
|
||||
<!-- Title -->
|
||||
### Template
|
||||
|
||||
<!-- Description -->
|
||||
Simple repository template
|
||||
|
||||
<!-- Any badges -->
|
||||
<!-- Repo badges -->
|
||||
[](https://git.zakscode.com/ztimson/template/tags)
|
||||
[](https://git.zakscode.com/ztimson/template/pulls)
|
||||
[](https://git.zakscode.com/ztimson/template/issues)
|
||||
|
||||
<!-- Screenshot -->
|
||||
<!-- ![]() -->
|
||||
<!-- Links -->
|
||||
|
||||
Long desciption
|
||||
---
|
||||
<div>
|
||||
<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
|
||||
- [Template Name](#template-name)
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [Stack](#stack)
|
||||
- [Template](#top)
|
||||
- [About](#about)
|
||||
- [Demo](#demo)
|
||||
- [Built With](#built-with)
|
||||
- [Setup](#setup)
|
||||
- [Development](#development)
|
||||
- [Production](#production)
|
||||
- [Cheatsheet](#cheatsheet)
|
||||
- [Development](#development)
|
||||
- [License](#license)
|
||||
|
||||
## Stack
|
||||
| Technology | Version |
|
||||
|------------|---------|
|
||||
| | |
|
||||
## About
|
||||
|
||||
## 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.
|
||||
|
||||
### Demo
|
||||
|
||||
Website: https://git.zakscode.com
|
||||
|
||||
### Built With
|
||||
[](https://angular.io/)
|
||||
[](https://www.android.com/)
|
||||
[](https://www.arduino.cc/)
|
||||
[](https://getbootstrap.com)
|
||||
[](https://en.cppreference.com/w/c/language)
|
||||
[](https://cplusplus.com/)
|
||||
[](https://dotnet.microsoft.com/)
|
||||
[](https://www.w3.org/Style/CSS/Overview.en.html)
|
||||
[](https://www.djangoproject.com/)
|
||||
[](https://docker.com/)
|
||||
[](https://www.electronjs.org/)
|
||||
[](https://firebase.google.com/)
|
||||
[](https://go.dev/)
|
||||
[](https://graphql.org/)
|
||||
[](https://developer.mozilla.org/en-US/docs/Glossary/HTML)
|
||||
[](https://java.com/)
|
||||
[](https://javascript.com/)
|
||||
[](https://jquery.com )
|
||||
[](https://laravel.com)
|
||||
[](https://www.linux.org/)
|
||||
[](https://git.zakscode.com/ztimson/momentum)
|
||||
[](https://www.mongodb.com/)
|
||||
[](https://www.mysql.com/)
|
||||
[](https://nestjs.com/)
|
||||
[](https://dotnet.microsoft.com/)
|
||||
[](https://nextjs.org/)
|
||||
[](https://www.nginx.com/)
|
||||
[](https://nodejs.org/)
|
||||
[](https://p5js.org/)
|
||||
[](https://www.php.net/)
|
||||
[](https://www.postgresql.org/)
|
||||
[](https://www.python.org/)
|
||||
[](https://reactjs.org/)
|
||||
[](https://redis.com/)
|
||||
[](https://sass-lang.com/)
|
||||
[](https://en.wikipedia.org/wiki/Shell_script)
|
||||
[](https://www.microsoft.com/en-ca/sql-server)
|
||||
[](https://www.sqlite.org/index.html)
|
||||
[](https://svelte.dev/)
|
||||
[](https://typescriptlang.org/)
|
||||
[](https://microsoft.com/windows)
|
||||
[](https://vitejs.dev/)
|
||||
[](https://vuejs.org/)
|
||||
|
||||
## Setup
|
||||
<details>
|
||||
<summary>
|
||||
<h3 id="development" style="display: inline">
|
||||
Development
|
||||
</h3>
|
||||
</summary>
|
||||
|
||||
#### Prerequisites
|
||||
- ...
|
||||
|
||||
#### Instructions
|
||||
1. ...
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
@ -52,20 +102,31 @@ Long desciption
|
||||
</summary>
|
||||
|
||||
#### 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)
|
||||
</details>
|
||||
|
||||
## Cheatsheet
|
||||
```bash
|
||||
# Start redis
|
||||
docker-compose up redis
|
||||
<details>
|
||||
<summary>
|
||||
<h3 id="development" style="display: inline">
|
||||
Development
|
||||
</h3>
|
||||
</summary>
|
||||
|
||||
# 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)
|
||||
|
||||
</details>
|
||||
|
||||
## License
|
||||
Copyright © 2023 Zakary Timson | All Rights Reserved | Available under MIT Licensing
|
||||
|
||||
See the [license](./LICENSE) for more information.
|
||||
|
Reference in New Issue
Block a user