diff --git a/README.md b/README.md index d93f9fb..aa9c490 100644 --- a/README.md +++ b/README.md @@ -1,87 +1,98 @@ - -
-
- - - - Logo - - - - ### 291st Joint Task Force - - - Clan website for the _291st Joint Task Force_ - - - [![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) - -
- -## 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 - -
- -

- Production -

-
- -#### 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) -
- -
- -

- Development -

-
- -#### 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) - -
- -## License -Copyright © 2023 Zakary Timson | All Rights Reserved - -See the [license](./LICENSE) for more information. + +
+
+ + + + Logo + + + + ### 291st Joint Task Force + + + Clan website for the _291st Joint Task Force_ + + + [![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) + + + + --- +
+ Release Notes + • Report a Bug + • Request a Feature +
+ + --- +
+ +## 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 + +
+ +

+ Production +

+
+ +#### 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) +
+ +
+ +

+ Development +

+
+ +#### 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) + +
+ +## License +Copyright © 2023 Zakary Timson | All Rights Reserved + +See the [license](./LICENSE) for more information.