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

Update README.md
All checks were successful
Build / Dependencies_NPM (push) Successful in 1m8s
Details

Browse Source
This commit is contained in:
Zakary Timson 2023-07-28 01:43:11 +00:00
parent 7e116416ad
commit 99c127e9ab
1 changed files with 29 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -1,10 +1,7 @@
# 291st JTF # 291st JTF
---
> "Putting the Damned to Rest" > "Putting the Damned to Rest"
![Skull Sword and Globe Emblem](./src/assets/img/logo.png) ![Skull Sword and Globe Emblem](./src/assets/img/logo.png)
This is the clan [website](https://291st.ca) for the 291st Joint Task Force. This is the clan [website](https://291st.ca) for the 291st Joint Task Force.
@ -12,37 +9,51 @@ This is the clan [website](https://291st.ca) for the 291st Joint Task Force.
This project was generated using Angular 14. This project was generated using Angular 14.
## Table of Contents ## Table of Contents
<!-- TOC --> - [291st JTF](#291st-jtf)
* [291st JTF](#291st-jtf) - [Table of Contents](#table-of-contents)
* [Table of Contents](#table-of-contents) - [Stack](#stack)
* [Prerequisites](#prerequisites) - [Setup](#setup)
* [Setup](#setup) - [Development](#development)
* [Cheatsheet](#cheatsheet) - [Production](#produciton)
<!-- TOC --> - [Cheatsheet](#cheatsheet)
## Prerequisites ## Stack
- [NodeJS](https://nodejs.org/en/) | Technology | Version |
- [Docker](https://docs.docker.com/install/) |------------|---------|
| Node | 16 |
| Angular | 14 |
| Docker | |
## Setup ## Setup
The project can either be run using NPM or Docker. NPM is recommended for development.
<details> <details>
<summary>NPM (Development)</summary> <summary>
<h3 style="display: inline">Development</h3>
</summary>
#### Prerequisites
- [NodeJS](https://nodejs.org/en/)
#### Instructions
1. Install the dependencies: `npm install` 1. Install the dependencies: `npm install`
2. Start the Angular server: `npm run start` 2. Start the Angular server: `npm run start`
3. Open [http://localhost:4200](http://localhost:4200)
</details> </details>
<details> <details>
<summary>Docker (Production)</summary> <summary>
<h3 style="display: inline">Production</h3>
</summary>
#### Prerequisites
- [Docker](https://docs.docker.com/install/)
#### Instructions
1. Build the docker image: `docker build -t 291st:<TAG> .` 1. Build the docker image: `docker build -t 291st:<TAG> .`
2. Start the new image: `docker run -p 4200:80 291st:<TAG>` 2. Start the new image: `docker run -p 4200:80 291st:<TAG>`
3. Open [http://localhost:4200](http://localhost:4200)
</details> </details>
The website should now be accessible on [http://localhost:4200](http://localhost:4200)
## Cheatsheet ## Cheatsheet
```bash ```bash
# Start Angular server # Start Angular server