legio-30/README.md

48 lines
1.1 KiB
Markdown
Raw Normal View History

2022-05-05 23:53:20 -04:00
# LEGIO · XXX
Legio XXX is the website for a North American Roman re-enactment group.
2022-09-14 22:07:17 -04:00
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 14.2.2.
2022-05-05 23:53:20 -04:00
2022-09-14 22:07:17 -04:00
## Table of Contents
2022-05-05 23:53:20 -04:00
[[_TOC_]]
2022-09-14 22:07:17 -04:00
## 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)_
## Setup
2022-09-14 22:10:52 -04:00
The project can either be run using NPM or Docker. NPM is recommended for development.
2022-09-14 22:07:17 -04:00
<details>
<summary>NPM</summary>
1. Install the dependencies: `npm install`
2. Start the Angular server: `npm run start`
</details>
<details>
<summary>Docker</summary>
1. Build the docker image: `docker build -t legio-xxx:<TAG> .`
2. Start the new image: `docker run -p 4200:80 legio-xxx:<TAG>`
</details>
The website should now be accessible on [http://localhost:4200](http://localhost:4200)
## Cheatsheet
```bash
# Start Angular server
npm run start
# Build production
2022-09-14 22:10:52 -04:00
npm run build:prod
2022-09-14 22:07:17 -04:00
2022-09-14 22:10:52 -04:00
# Build docker image
docker build -t legio-xxx:<TAG>
2022-09-14 22:07:17 -04:00
2022-09-14 22:10:52 -04:00
# Run docker image
docker run -p 4200:80 legio-xxx:<TAG>
2022-09-14 22:07:17 -04:00
```