mirror of https://github.com/captbaritone/webamp synced 2024-11-22 16:20:49 +00:00

History

Jordan Eldredge b8438caf42 file extension matching should be case insensitive		2023-04-14 09:26:39 -07:00
..
.netlify
public	Use use image for social card for root url	2022-11-13 08:17:47 -08:00
src	file extension matching should be case insensitive	2023-04-14 09:26:39 -07:00
.gitignore	Ignore build	2022-09-20 21:45:42 -07:00
graphql.config.json
netlify.toml	Deploy the musuem client whenever Webamp itself is updated	2023-01-20 10:13:04 -08:00
package.json	Access Webamp from window	2023-01-23 22:42:40 -08:00
README.md	Add instructions for developing the client and server at the same time	2022-09-21 20:09:32 -07:00
styleguide.config.js	Format	2022-10-23 13:42:11 -07:00

README.md

Winamp Skin Museum Client

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.

Development

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

By default the client will connect to the production API. This works great for client-only changes. If you need to make changes which span both the client and the server, you will need to make some changes.

Start the server locally:

cd pacakges/skin-database
yarn
yarn start

This should start the server on port 3001.

Now update the API_URL constant in src/constants.js to "http://localhost:3001". This will tell the client to connect to the local server instead of the production API.

Finally, in a separate terminal, start the client as outlined at the top of this section.

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.