Update README.md
	
		
			
	
		
	
	
		
	
		
			Some checks failed
		
		
	
	
	
				
					
				
			
		
			Some checks failed
		
		
	
	
This commit is contained in:
		
							
								
								
									
										118
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										118
									
								
								README.md
									
									
									
									
									
								
							@@ -1,45 +1,64 @@
 | 
			
		||||

 | 
			
		||||
<!-- 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 -->
 | 
			
		||||
  A clan website for the _291st Joint Task Force_
 | 
			
		||||
 | 
			
		||||
  <!-- Repo badges -->
 | 
			
		||||
  [](https://git.zakscode.com/ztimson/291st/tags)
 | 
			
		||||
  [](https://git.zakscode.com/ztimson/291st/pulls)
 | 
			
		||||
  [](https://git.zakscode.com/ztimson/291st/issues)
 | 
			
		||||
 | 
			
		||||
  <!-- Tech Badges -->
 | 
			
		||||
  [](https://angular.io/)
 | 
			
		||||
  [](https://getbootstrap.com)
 | 
			
		||||
  [](https://docker.com/)
 | 
			
		||||
  [](https://nodejs.org/)
 | 
			
		||||
 | 
			
		||||
  </br>
 | 
			
		||||
</div>
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
Clan website built for the _291st Joint Task Force_
 | 
			
		||||
<div align="center">
 | 
			
		||||
  <a href="https://291st.ca" target="_blank">Demo</a>
 | 
			
		||||
   • <a href="https://git.zakscode.com/ztimson/291st/wiki" target="_blank">Documentation</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">Feature Request</a> 
 | 
			
		||||
</div>
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
## Table of Contents
 | 
			
		||||
- [291st JTF](#291st-jtf)
 | 
			
		||||
  - [Table of Contents](#table-of-contents)
 | 
			
		||||
  - [Demo](#demo)
 | 
			
		||||
  - [Stack](#stack)
 | 
			
		||||
  - [Setup](#setup)
 | 
			
		||||
    - [Development](#development)
 | 
			
		||||
- [291st](#top)
 | 
			
		||||
  - [Demo](https://291st.ca)
 | 
			
		||||
  - [Documentation](https://git.zakscode.com/ztimson/291st/wiki)
 | 
			
		||||
  - [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)
 | 
			
		||||
- [Setup](#setup)
 | 
			
		||||
  - [Production](#production)
 | 
			
		||||
  - [Cheatsheet](#cheatsheet)
 | 
			
		||||
  - [Development](#development)
 | 
			
		||||
- [License](#license)
 | 
			
		||||
 | 
			
		||||
## Demo
 | 
			
		||||
[https://291st.ca](https://291st.ca)
 | 
			
		||||
## About
 | 
			
		||||
 | 
			
		||||
## Stack
 | 
			
		||||
| Technology | Version |
 | 
			
		||||
|------------|---------|
 | 
			
		||||
| Node       | 16      |
 | 
			
		||||
| Angular    | 14      |
 | 
			
		||||
| Docker     |         |
 | 
			
		||||
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_.
 | 
			
		||||
 | 
			
		||||
## Setup
 | 
			
		||||
<details>
 | 
			
		||||
<summary>
 | 
			
		||||
  <h3 id="development" style="display: inline">
 | 
			
		||||
    Development
 | 
			
		||||
  </h3>
 | 
			
		||||
</summary>
 | 
			
		||||
 | 
			
		||||
#### Prerequisites
 | 
			
		||||
- [NodeJS](https://nodejs.org/en/)
 | 
			
		||||
 | 
			
		||||
#### Instructions
 | 
			
		||||
1. Install the dependencies: `npm install`
 | 
			
		||||
2. Start the Angular server: `npm run start`
 | 
			
		||||
3. Open [http://localhost:4200](http://localhost:4200)
 | 
			
		||||
</details>
 | 
			
		||||
 | 
			
		||||
<details>
 | 
			
		||||
<summary>
 | 
			
		||||
@@ -52,23 +71,28 @@ Clan website built for the _291st Joint Task Force_
 | 
			
		||||
- [Docker](https://docs.docker.com/install/)
 | 
			
		||||
 | 
			
		||||
#### Instructions
 | 
			
		||||
1. Build the docker image: `docker build -t 291st:<TAG> .`
 | 
			
		||||
2. Start the new image: `docker run -p 4200:80 291st:<TAG>`
 | 
			
		||||
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>
 | 
			
		||||
 | 
			
		||||
## Cheatsheet
 | 
			
		||||
```bash
 | 
			
		||||
# Start Angular server
 | 
			
		||||
npm run start
 | 
			
		||||
## License
 | 
			
		||||
Copyright © ZaksCode 2023 | All Rights Reserved
 | 
			
		||||
 | 
			
		||||
# Build production
 | 
			
		||||
npm run build:prod
 | 
			
		||||
 | 
			
		||||
# Build docker image
 | 
			
		||||
docker build -t 291st:<TAG>
 | 
			
		||||
 | 
			
		||||
# Run docker image
 | 
			
		||||
docker run -p 4200:80 291st:<TAG>
 | 
			
		||||
```
 | 
			
		||||
See the [license](./LICENSE) for more information.
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user