Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tylergaw/wax
A record collection viewer
https://github.com/tylergaw/wax
astro discogs-api openai vinyl-records vitest
Last synced: 24 days ago
JSON representation
A record collection viewer
- Host: GitHub
- URL: https://github.com/tylergaw/wax
- Owner: tylergaw
- Created: 2022-12-05T05:50:16.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-19T02:17:39.000Z (5 months ago)
- Last Synced: 2024-12-07T06:29:58.418Z (27 days ago)
- Topics: astro, discogs-api, openai, vinyl-records, vitest
- Language: Astro
- Homepage: https://wax.tylergaw.com
- Size: 305 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Wax [](https://app.netlify.com/sites/on-wax/deploys)
A record collection viewer with data from Discogs.
- Production: [wax.tylergaw.com](https://wax.tylergaw.com/)
- Staging: Every pull request gets a preview deploy URL
> [!IMPORTANT]
>
> Fetching, enriching, and uploading collection data happens in [github.com/tylergaw/wax-tracks](https://github.com/tylergaw/wax-tracks).
## Technology overview
- This is a static site built with [Astro](https://astro.build/)
- Data fetcher/munger/uploader [github.com/tylergaw/wax-tracks](https://github.com/tylergaw/wax-tracks)
- Discogs API [discogs.com/developers/](https://www.discogs.com/developers/)
- Node >= v17.0.0
- Hosted on Netlify
- OpenAI API for data enrichment
## Local setup
**Install dependencies**
```
yarn
```
**Start development server**
```
yarn start
```
The site will be available at [http://localhost:3000](http://localhost:3000)
**Preview production**
Do a production build and local server to mimic a production environment. Note that there's no reload when files are changed.
```
yarn preview
```
**Build for production**
Generates static content into the `dist` directory that can be served using any static content hosting service.
```
yarn build
```
## Tests
This project can have a little tests, as a snack. Run using `vitest` with
```
yarn test
```
## Deployment
### To production
This site is hosted on Netlify. Anything merged into the `main` branch is deployed to production.
### To staging
This site uses Netlify preview builds. To see any branch in a live environment, push the branch to the remote and open a pull request.