Skip to content

Commit

Permalink
Update project documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kleinfreund committed Nov 16, 2024
1 parent bfca19a commit 7cb420b
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 7 deletions.
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,37 @@
# kleinfreund.de

## Prerequisites
## Development

Install the project's dependencies.

```sh
npm install
```

## Development
Start a local development server.

```sh
npm start
```

## Production
### Generate favicon

Create a 48×48 px favicon out of an SVG file:

```sh
npm run build
magick -background none -density 48x48 icon.svg favicon.ico
```

## Generate favicon
### Update vinyl collection

Create a 48×48 px favicon out of an SVG file:
Run the following package script:

```sh
magick -background none -density 48x48 icon.svg favicon.ico
npm run build:vinyl-collection-data
```

Commit any changed files resulting from this step.

## Deploy

Push updates to the project's default branch. This will trigger a GitHub action deploying the site.
6 changes: 6 additions & 0 deletions discogs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# kleinfreund.de: vinyl collection

In order to run the scripts in this directory, set the following environment variables:

- `DISCOGS_PAT`: Your Discogs personal access token. Used to authenticate with the [Discogs API](https://www.discogs.com/developers#page:authentication,header:authentication-discogs-auth-flow).
- `DISCOGS_USERNAME`: Your Discogs username. Indicates the user whose vinyl collection to retrieve via the [Collections Items By Folder API endpoint](https://www.discogs.com/developers#page:user-collection,header:user-collection-collection-items-by-folder).

0 comments on commit 7cb420b

Please sign in to comment.