Update README.md
This commit is contained in:
parent
2cf0d62aad
commit
625af2ed6a
185
README.md
185
README.md
@ -1,87 +1,98 @@
|
|||||||
<!-- Header -->
|
<!-- Header -->
|
||||||
<div id="top" align="center">
|
<div id="top" align="center">
|
||||||
<br />
|
<br />
|
||||||
|
|
||||||
<!-- Logo -->
|
<!-- Logo -->
|
||||||
<a href="/src/assets/img/header.png">
|
<a href="/src/assets/img/header.png">
|
||||||
<img src="./src/assets/img/logo.png" alt="Logo" width="200" height="200">
|
<img src="./src/assets/img/logo.png" alt="Logo" width="200" height="200">
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
<!-- Title -->
|
<!-- Title -->
|
||||||
### 291st Joint Task Force
|
### 291st Joint Task Force
|
||||||
|
|
||||||
<!-- Description -->
|
<!-- Description -->
|
||||||
Clan website for the _291st Joint Task Force_
|
Clan website for the _291st Joint Task Force_
|
||||||
|
|
||||||
<!-- 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/291st/tags&query=$[0].name)](https://git.zakscode.com/ztimson/291st/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/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)
|
[![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)
|
||||||
</div>
|
|
||||||
|
<!-- Links -->
|
||||||
## Table of Contents
|
|
||||||
- [291st](#top)
|
---
|
||||||
- [About](#about)
|
<div>
|
||||||
- [Built With](#built-with)
|
<a href="https://git.zakscode.com/ztimson/291st/releases" target="_blank">Release Notes</a>
|
||||||
- [Demo](https://291st.ca)
|
• <a href="https://git.zakscode.com/ztimson/291st/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
|
||||||
- [Setup](#setup)
|
• <a href="https://git.zakscode.com/ztimson/291st/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
|
||||||
- [Production](#production)
|
</div>
|
||||||
- [Development](#development)
|
|
||||||
- [License](#license)
|
---
|
||||||
|
</div>
|
||||||
## About
|
|
||||||
|
## Table of Contents
|
||||||
This website was created for the _291st Joint Task Force_ to act as a simple landing page for their domain.
|
- [291st](#top)
|
||||||
|
- [About](#about)
|
||||||
It includes a list of managed servers & the _Discord_ server list.
|
- [Demo](https://291st.ca)
|
||||||
|
- [Built With](#built-with)
|
||||||
The technology stack consists of a front-end built with _Angular_ & is deployed using _Docker_.
|
- [Setup](#setup)
|
||||||
|
- [Production](#production)
|
||||||
### Built With
|
- [Development](#development)
|
||||||
[![Angular](https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular)](https://angular.io/)
|
- [License](#license)
|
||||||
[![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/)
|
## About
|
||||||
[![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/)
|
This website was created for the _291st Joint Task Force_ to act as a simple landing page for their domain.
|
||||||
|
|
||||||
## Demo
|
It includes a list of managed servers & the _Discord_ server list.
|
||||||
Website: https://291st.ca
|
|
||||||
|
The technology stack consists of a front-end built with _Angular_ & is deployed using _Docker_.
|
||||||
## Setup
|
|
||||||
|
## Demo
|
||||||
<details>
|
Website: https://291st.ca
|
||||||
<summary>
|
|
||||||
<h3 id="production" style="display: inline">
|
### Built With
|
||||||
Production
|
[![Angular](https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular)](https://angular.io/)
|
||||||
</h3>
|
[![Bootstrap](https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white)](https://getbootstrap.com)
|
||||||
</summary>
|
[![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/)
|
||||||
#### Prerequisites
|
[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/)
|
||||||
- [Docker](https://docs.docker.com/install/)
|
|
||||||
|
## Setup
|
||||||
#### Instructions
|
|
||||||
1. Run the docker image: `docker run -p 80:80 git.zakscode.com/ztimson/291st:latest`
|
<details>
|
||||||
2. Open [http://localhost](http://localhost)
|
<summary>
|
||||||
</details>
|
<h3 id="production" style="display: inline">
|
||||||
|
Production
|
||||||
<details>
|
</h3>
|
||||||
<summary>
|
</summary>
|
||||||
<h3 id="development" style="display: inline">
|
|
||||||
Development
|
#### Prerequisites
|
||||||
</h3>
|
- [Docker](https://docs.docker.com/install/)
|
||||||
</summary>
|
|
||||||
|
#### Instructions
|
||||||
#### Prerequisites
|
1. Run the docker image: `docker run -p 80:80 git.zakscode.com/ztimson/291st:latest`
|
||||||
- [Node.js](https://nodejs.org/en/download)
|
2. Open [http://localhost](http://localhost)
|
||||||
|
</details>
|
||||||
#### Instructions
|
|
||||||
1. Install the dependencies: `npm install`
|
<details>
|
||||||
2. Start the Angular server: `npm run start`
|
<summary>
|
||||||
3. Open [http://localhost:4200](http://localhost:4200)
|
<h3 id="development" style="display: inline">
|
||||||
|
Development
|
||||||
</details>
|
</h3>
|
||||||
|
</summary>
|
||||||
## License
|
|
||||||
Copyright © 2023 Zakary Timson | All Rights Reserved
|
#### Prerequisites
|
||||||
|
- [Node.js](https://nodejs.org/en/download)
|
||||||
See the [license](./LICENSE) for more information.
|
|
||||||
|
#### 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.
|
||||||
|
Loading…
Reference in New Issue
Block a user