-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
bfca19a
commit 7cb420b
Showing
2 changed files
with
23 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |