This commit is contained in:
29
README.md
29
README.md
@@ -1,27 +1,40 @@
|
||||
# 291st JTF
|
||||
[Clan page](https://291st.ca) for the 291st Joint Task Force
|
||||
|
||||
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 14.2.2.
|
||||
---
|
||||
|
||||
> "Putting the Damned to Rest"
|
||||
|
||||
|
||||

|
||||
|
||||
This is the clan [website](https://291st.ca) for the 291st Joint Task Force.
|
||||
|
||||
This project was generated using Angular 14.
|
||||
|
||||
## Table of Contents
|
||||
[[_TOC_]]
|
||||
<!-- TOC -->
|
||||
* [291st JTF](#291st-jtf)
|
||||
* [Table of Contents](#table-of-contents)
|
||||
* [Prerequisites](#prerequisites)
|
||||
* [Setup](#setup)
|
||||
* [Cheatsheet](#cheatsheet)
|
||||
<!-- TOC -->
|
||||
|
||||
## Prerequisites
|
||||
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
|
||||
- [NodeJS 16](https://nodejs.org/en/)
|
||||
- _[Docker](https://docs.docker.com/install/) (Optional)_
|
||||
- [NodeJS](https://nodejs.org/en/)
|
||||
- [Docker](https://docs.docker.com/install/)
|
||||
|
||||
## Setup
|
||||
The project can either be run using NPM or Docker. NPM is recommended for development.
|
||||
<details>
|
||||
<summary>NPM</summary>
|
||||
<summary>NPM (Development)</summary>
|
||||
|
||||
1. Install the dependencies: `npm install`
|
||||
2. Start the Angular server: `npm run start`
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Docker</summary>
|
||||
<summary>Docker (Production)</summary>
|
||||
|
||||
1. Build the docker image: `docker build -t 291st:<TAG> .`
|
||||
2. Start the new image: `docker run -p 4200:80 291st:<TAG>`
|
||||
|
||||
Reference in New Issue
Block a user