A template for automatically generating static "project" websites that showcase media (e.g. albums, games, videos, etc.) in an attractive, yet simple, light-weight, responsive, mobile-friendly way.
- Installation
- Configuration
- Generate website
- Serve locally with http-server
- Test with Cypress
- Copyright
- License
-
Use or fork this template.
-
To install the required dependencies, run:
npm install
Note: There is a postinstall routine that will initialize and update the Project Website Submodule.
Modify the webpack.config.html.js file with data specific to the desired website. For example:
- Title
- Meta data
- Logo
- Tagline
- Links
- Copyright
Modify the webpack.config.projects.js file with project specific data. For example:
- Album
- Title
- Cover Artwork
- Tracks
- Embedded SoundCloud Player
- Year
- Game
- Title
- Links
- Play Online
- Download
- Year
- Video
- Title
- Embedded YouTube Video
- Year
- images/android-chrome-192x192.png
- images/android-chrome-512x512.png
- images/apple-touch-icon.png
- images/favicon.ico
- images/favicon.svg
- images/logo.png
Note: The viewable area of each template image is marked in gray or black.
To generate the full website from the modified configuration, run:
npm run build
Note: All website files will be output into the dist/ directory.
List of CDN dependencies:
Serve locally with http-server
- To install http-server globally, run:
npm install --global http-server
- To start the server, open a new terminal to this repo and run:
npm run server
- To view the website, open: https://localhost:8080
Test with Cypress
To test the website, first serve locally with http-server, then run:
npm run test
Copyright (c) 2021 X28 Project