Updated gitignore and README.

This commit is contained in:
steverusso 2020-04-10 16:12:27 -04:00
parent 87613f77be
commit e9102cb58d
2 changed files with 14 additions and 49 deletions

8
.gitignore vendored
View File

@ -1,14 +1,8 @@
# Logs # Logs
logs logs
*.log *.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
package-lock.json public
node_modules/
dist
# IDE # IDE
.idea .idea

View File

@ -1,55 +1,26 @@
# Simple Systems Website # Simple Systems Website
Built using [Hugo](https://gohugo.io/getting-started/installing/)
## Local development ## Local development
Build image ```
```shell script hugo server
docker build -f Dockerfile.dev -t website-fe .
``` ```
Run the container using the current directory for the source files ## Production
```shell script To build the production site, run the following command:
docker run -it -p 8080:8080 --mount source=$(pwd),target=/src,type=bind --rm website-fe ```
hugo --minify
``` ```
## Building (non docker) The resources will be stored in the `./public` directory.
To create a production build, run:
```shell script
yarn
yarn build
```
The static resources will be stored in the `./dist` directory.
## Production Docker build and run
To build the production site in a docker container, run the following command:
```shell script
docker build -f Dockerfile.prod -t website-rel .
```
To run the production container, run the following command:
```shell script
docker run --rm -it -p 8080:8080 website-rel
```
## Managing Job Posts ## Managing Job Posts
To add a job post: * To add a job post, create the markdown file in `content/jobs`.
1. Place the markdown file in `./src/job-posts`. * To remove a job post, remove its markdown file from `content/jobs`.
2. Add the file name (excluding the extension) as an entry `./src/assets/jobKeys.js`.
These entries determine the display order.
To remove a job post:
1. Remove the markdown file from `./src/job-posts`.
2. Remove the entry from the data in `./src/assets/jobKeys.js`.
## Managing Blog Posts ## Managing Blog Posts
To add a blog post: * To add a blog post, create the markdown file in `content/blog`.
1. Place the markdown file in `./src/blog-posts`. * To remove a blog post, remove its markdown file from `content/blog`.
2. Add the file name (excluding the extension) as an entry `./src/assets/blogKeys.js`.
These entries determine the display order.
To remove a blog post:
1. Remove the markdown file from `./src/blog-posts`.
2. Remove the entry from the data in `./src/assets/blogKeys.js`.