Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fulldecent/github-pages-template
An opinionated starting point and build system for awesome, collaboratively-edited HTML websites
https://github.com/fulldecent/github-pages-template
html html-website template travis-ci validation
Last synced: 4 days ago
JSON representation
An opinionated starting point and build system for awesome, collaboratively-edited HTML websites
- Host: GitHub
- URL: https://github.com/fulldecent/github-pages-template
- Owner: fulldecent
- Created: 2017-01-18T18:54:30.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-12-20T21:45:59.000Z (15 days ago)
- Last Synced: 2024-12-27T12:15:36.377Z (9 days ago)
- Topics: html, html-website, template, travis-ci, validation
- Language: JavaScript
- Homepage: https://fulldecent.github.io/github-pages-template/
- Size: 268 KB
- Stars: 35
- Watchers: 6
- Forks: 50
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# How to run this application locally
## Setup environment
_In production (GitHub Actions), environment is setup by by workflows in [.github/workflows/](.github/workflows/)._
_For local testing (try VS Code + Dev Containers extension, Podman Desktop), these steps are performed by [.devcontainer/](.devcontainer/) when you run Reopen in Container._
1. Install Ruby (use version in [build-test-deploy.yml](https://github.com/fulldecent/github-pages-template/blob/main/.github/workflows/build-test-deploy.yml) in "Setup Ruby", (try rbenv)
1. Install Jekyll
```sh
gem update --system
gem install bundler
bundle install
```
1. Install Node & yarn, use version in build-test-deploy.yml in "Setup Node.js", (try nvm)
```sh
nvm install --lts --reinstall-packages-from=current
nvm use --lts
yarn install
```
## Build the site
Build the HTML website (see available localhost:#### port in the console output):
```sh
bundle exec jekyll build
```
## Serve/run the site
```sh
bundle exec jekyll serve
```
To live reload changes use:
```sh
bundle exec jekyll serve --livereload
```
## (Bonus) if you will build using Jekyll but deploy to a different server with a script interpreter
You can run PHP or similar on the built site. Here's how.
```sh
(cd build; php -S localhost:4001)
```
## Testing
All testing is performed using Node scripts:
```sh
yarn test
```
## VS Code
Open this folder in VS Code and install recommended extensions. Then use "Reload Window" to activate them.
This will give you formatting, linting, and other tools to help you develop.