ztimson/291st
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases Activity

Update README.md
Some checks failed
Build Website / Build NPM Project (push) Successful in 25s
Details
Build Website / Tag Version (push) Successful in 6s
Details
Build Website / Build & Push Dockerfile (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Zakary Timson
2023-12-05 04:40:02 +00:00
parent 2cf0d62aad
commit 625af2ed6a
1 changed files with 98 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

185
README.md
View File

@@ -1,87 +1,98 @@
<!-- Header -->
<div id="top" align="center">
<br />
<!-- Logo -->
<a href="/src/assets/img/header.png">
<img src="./src/assets/img/logo.png" alt="Logo" width="200" height="200">
</a>
<!-- Title -->
### 291st Joint Task Force
<!-- Description -->
Clan website for the _291st Joint Task Force_
<!-- 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/291st/tags&query=$[0].name)](https://git.zakscode.com/ztimson/291st/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/291st&query=open_pr_counter)](https://git.zakscode.com/ztimson/291st/pulls)
</div>
## Table of Contents
- [291st](#top)
- [About](#about)
- [Built With](#built-with)
- [Demo](https://291st.ca)
- [Setup](#setup)
- [Production](#production)
- [Development](#development)
- [License](#license)
## About
This website was created for the _291st Joint Task Force_ to act as a simple landing page for their domain.
It includes a list of managed servers & the _Discord_ server list.
The technology stack consists of a front-end built with _Angular_ & is deployed using _Docker_.
### Built With
[![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/)
## Demo
Website: https://291st.ca
## Setup
<details>
<summary>
<h3 id="production" style="display: inline">
Production
</h3>
</summary>
#### Prerequisites
- [Docker](https://docs.docker.com/install/)
#### Instructions
1. Run the docker image: `docker run -p 80:80 git.zakscode.com/ztimson/291st:latest`
2. Open [http://localhost](http://localhost)
</details>
<details>
<summary>
<h3 id="development" style="display: inline">
Development
</h3>
</summary>
#### Prerequisites
- [Node.js](https://nodejs.org/en/download)
#### 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
See the [license](./LICENSE) for more information.
<!-- Header -->
<div id="top" align="center">
<br />
<!-- Logo -->
<a href="/src/assets/img/header.png">
<img src="./src/assets/img/logo.png" alt="Logo" width="200" height="200">
</a>
<!-- Title -->
### 291st Joint Task Force
<!-- Description -->
Clan website for the _291st Joint Task Force_
<!-- 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/291st/tags&query=$[0].name)](https://git.zakscode.com/ztimson/291st/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/291st&query=open_pr_counter)](https://git.zakscode.com/ztimson/291st/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/291st&query=open_issues_count)](https://git.zakscode.com/ztimson/291st/issues)
<!-- Links -->
---
<div>
<a href="https://git.zakscode.com/ztimson/291st/releases" target="_blank">Release Notes</a>
• <a href="https://git.zakscode.com/ztimson/291st/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
• <a href="https://git.zakscode.com/ztimson/291st/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
</div>
---
</div>
## Table of Contents
- [291st](#top)
- [About](#about)
- [Demo](https://291st.ca)
- [Built With](#built-with)
- [Setup](#setup)
- [Production](#production)
- [Development](#development)
- [License](#license)
## About
This website was created for the _291st Joint Task Force_ to act as a simple landing page for their domain.
It includes a list of managed servers & the _Discord_ server list.
The technology stack consists of a front-end built with _Angular_ & is deployed using _Docker_.
## Demo
Website: https://291st.ca
### Built With
[![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/)
## Setup
<details>
<summary>
<h3 id="production" style="display: inline">
Production
</h3>
</summary>
#### Prerequisites
- [Docker](https://docs.docker.com/install/)
#### Instructions
1. Run the docker image: `docker run -p 80:80 git.zakscode.com/ztimson/291st:latest`
2. Open [http://localhost](http://localhost)
</details>
<details>
<summary>
<h3 id="development" style="display: inline">
Development
</h3>
</summary>
#### Prerequisites
- [Node.js](https://nodejs.org/en/download)
#### 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
See the [license](./LICENSE) for more information.