Clean up deploy, add some docs for museum client

This commit is contained in:
Jordan Eldredge 2022-09-21 19:53:17 -07:00
parent 0d67d681ce
commit 5cb22989d3
4 changed files with 29 additions and 18 deletions

View file

@ -35,6 +35,7 @@ Webamp uses a [monorepo](https://en.wikipedia.org/wiki/Monorepo) approach, so in
* [`packages/webamp/demo`](https://github.com/captbaritone/webamp/tree/master/packages/webamp/demo): The demo site which lives at [webamp.org](https://webamp.org)
* [`packages/ani-cursor`](https://github.com/captbaritone/webamp/tree/master/packages/ani-cursor): An NPM module for rendering animiated `.ani` cursors as CSS animations
* [`packages/skin-database`](https://github.com/captbaritone/webamp/tree/master/packages/skin-database): The server component of https://skins.webamp.org which also runs our [Twitter bot](https://twitter.com/winampskins), and a Discord bot for our community chat
* [`packages/skin-museum-client`](https://github.com/captbaritone/webamp/tree/master/packages/skin-museum-client): The front-end component of https://skins.webamp.org.
* [`packages/winamp-eqf`](https://github.com/captbaritone/webamp/tree/master/packages/winamp-eqf): An NPM module for parsing and constructing Winamp equalizer preset files (`.eqf`)
* [`packages/archive-org-webamp-integration-tests`](https://github.com/captbaritone/webamp/tree/master/packages/archive-org-webamp-integration-tests): An integration that confirms that archive.org's Webamp integration is working as expected
* [`packages/webamp-modern`](https://github.com/captbaritone/webamp/tree/master/packages/webamp-modern): A prototype exploring rendering "modern" Winamp skins in the browser

View file

@ -1,13 +1,17 @@
# TODO
# Winamp Skin Museum Client
Generate skins
This package is the client for the Winamp Skin Museum. It is a React/Redux/RXJS application that uses the GraphQL API provided by the `skin-database` package in this same repository.
Minify skins
## Development
Generate json with array of:
Skin path
Screenshot path
Name
Color
```bash
cd packages/skin-museum-client
yarn
# Run this at least once to ensure the local version of Webamp has been built.
yarn build-webamp
yarn start
```
## Deployment
The Skin Museum client is deployed using Netlify. See the `netlify.toml` file in this same directory for details about how that works. The Netlify site is configured to use this subdirectory as it's base directory.

View file

@ -11,10 +11,9 @@ ID = "be420a16-4ef3-43b1-ac62-35869bdf8679"
publish = "build/"
# Default build command.
command = "cd ../webamp && yarn build-library && cd ../skin-museum-client && yarn build"
command = "yarn build"
[build.environment]
NODE_VERSION = "17.3.0"
SKIP_PREFLIGHT_CHECK = "true"
NETLIFY_USE_YARN = "true"

View file

@ -30,8 +30,9 @@
"spark-md5": "^3.0.1"
},
"scripts": {
"start": "react-scripts --openssl-legacy-provider start",
"build": "react-scripts --openssl-legacy-provider build",
"start": "SKIP_PREFLIGHT_CHECK=true react-scripts --openssl-legacy-provider start",
"build-webamp": "cd ../webamp && yarn build-library",
"build": "yarn build-webamp && SKIP_PREFLIGHT_CHECK=true react-scripts --openssl-legacy-provider build",
"test": "react-scripts test --env=jsdom",
"eject": "react-scripts eject",
"find-skins": "node ./scripts/findSkins.js",
@ -52,13 +53,19 @@
"extends": "react-app",
"overrides": [
{
"files": ["*.js"],
"processor": "@graphql-eslint/graphql"
},
"files": [
"*.js"
],
"processor": "@graphql-eslint/graphql"
},
{
"files": ["*.graphql"],
"files": [
"*.graphql"
],
"parser": "@graphql-eslint/eslint-plugin",
"plugins": ["@graphql-eslint"],
"plugins": [
"@graphql-eslint"
],
"rules": {
"@graphql-eslint/known-type-names": "error"
}