ztimson/legio-30
ztimson/legio-30
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases Activity

Update README.md
All checks were successful
Build Website / Build NPM Project (push) Successful in 1m8s
Details
Build Website / Tag Version (push) Successful in 6s
Details
Build Website / Build & Push Dockerfile (push) Successful in 1m34s
Details

Browse Source
This commit is contained in:
Zakary Timson 2023-12-08 00:59:42 +00:00
parent f5512e7750
commit 608c5099d2
1 changed files with 95 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

190
README.md
View File

@ -1,95 +1,95 @@
<!-- Header --> <!-- Header -->
<div id="top" align="center"> <div id="top" align="center">
<br /> <br />
<!-- Logo --> <!-- Logo -->
<img src="./src/assets/img/eagle.png" alt="Logo" width="200" height="200"> <img src="./src/assets/img/eagle.png" alt="Logo" width="200" height="200">
<!-- Title --> <!-- Title -->
### Legio • XXX ### Legio • XXX
<!-- Description --> <!-- Description -->
Roman Re-Enactment Website Roman Re-Enactment Website
<!-- Repo 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/legio-30/tags&query=$[0].name)](https://git.zakscode.com/ztimson/legio-30/tags) [![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/legio-30/tags&query=$[0].name)](https://git.zakscode.com/ztimson/legio-30/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/legio-30&query=open_pr_counter)](https://git.zakscode.com/ztimson/legio-30/pulls) [![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/legio-30&query=open_pr_counter)](https://git.zakscode.com/ztimson/legio-30/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/legio-30&query=open_issues_count)](https://git.zakscode.com/ztimson/legio-30/issues) [![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/legio-30&query=open_issues_count)](https://git.zakscode.com/ztimson/legio-30/issues)
<!-- Links --> <!-- Links -->
--- ---
<div> <div>
<a href="https://git.zakscode.com/ztimson/legio-30/releases" target="_blank">Release Notes</a> <a href="https://git.zakscode.com/ztimson/legio-30/releases" target="_blank">Release Notes</a>
• <a href="https://git.zakscode.com/ztimson/legio-30/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a> • <a href="https://git.zakscode.com/ztimson/legio-30/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
• <a href="https://git.zakscode.com/ztimson/legio-30/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a> • <a href="https://git.zakscode.com/ztimson/legio-30/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
</div> </div>
--- ---
</div> </div>
## Table of Contents ## Table of Contents
- [Legio • XXX](#top) - [Legio • XXX](#top)
- [About](#about) - [About](#about)
- [Demo](#demo) - [Demo](#demo)
- [Built With](#built-with) - [Built With](#built-with)
- [Setup](#setup) - [Setup](#setup)
- [Production](#production) - [Production](#production)
- [Development](#development) - [Development](#development)
- [License](#license) - [License](#license)
## About ## About
Legio XXX is a non-profit re-enactment group from southern Ontario & the north-eastern USA. Legio XXX is a non-profit re-enactment group from southern Ontario & the north-eastern USA.
This website was built to help educate the public and advertise events. This website was built to help educate the public and advertise events.
The website was written using Angular. The website was written using Angular.
### Demo ### Demo
Website: https://legio-30.org Website: https://legio-30.org
### Built With ### Built With
[![Angular](https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular)](https://angular.io/) [![Angular](https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular)](https://angular.io/)
[![Docker](https://img.shields.io/badge/Docker-384d54?style=for-the-badge&logo=docker)](https://docker.com/) [![Docker](https://img.shields.io/badge/Docker-384d54?style=for-the-badge&logo=docker)](https://docker.com/)
[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/) [![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/)
## Setup ## Setup
<details> <details>
<summary> <summary>
<h3 id="production" style="display: inline"> <h3 id="production" style="display: inline">
Production Production
</h3> </h3>
</summary> </summary>
#### Prerequisites #### Prerequisites
- [Docker](https://docs.docker.com/install/) - [Docker](https://docs.docker.com/install/)
#### Instructions #### Instructions
1. Run the docker image: `docker run -p 80:80 git.zakscode.com/ztimson/template:latest` 1. Run the docker image: `docker run -p 80:80 git.zakscode.com/ztimson/legio-30:latest`
2. Open [http://localhost](http://localhost) 2. Open [http://localhost](http://localhost)
</details> </details>
<details> <details>
<summary> <summary>
<h3 id="development" style="display: inline"> <h3 id="development" style="display: inline">
Development Development
</h3> </h3>
</summary> </summary>
#### Prerequisites #### Prerequisites
- [Node.js](https://nodejs.org/en/download) - [Node.js](https://nodejs.org/en/download)
#### Instructions #### Instructions
1. Install the dependencies: `npm install` 1. Install the dependencies: `npm install`
2. Start the Angular server: `npm run start` 2. Start the Angular server: `npm run start`
3. Open [http://localhost:4200](http://localhost:4200) 3. Open [http://localhost:4200](http://localhost:4200)
</details> </details>
## License ## License
Copyright © 2023 Zakary Timson | All Rights Reserved Copyright © 2023 Zakary Timson | All Rights Reserved
See the [license](./LICENSE) for more information. See the [license](./LICENSE) for more information.