Skip to content

Commit

Permalink
Update readme and package.json
Browse files Browse the repository at this point in the history
  • Loading branch information
HassanCorrigan committed Apr 8, 2021
1 parent 253d285 commit 942b57e
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ npm install

### User data

All personal data is saved in the [data.json](./src/data.json) file. You can customise it with any information you want, including a collection of songs or mixes.
All personal data is saved in the [data.json](./src/data.json) file. You can customize it with any information you want to include, such as a collection of songs or mixes.

**General**

Expand All @@ -33,6 +33,8 @@ All personal data is saved in the [data.json](./src/data.json) file. You can cus
| url | true | The dropbox url/link to your mix, a dropbox guide is found below |
| peaks | false | If you're using a particularly long audio clip, you can choose to pre-generate the waveform (guide found below) |

**The data.json file**

```json
{
"name": "DJ/Artist Name",
Expand All @@ -47,21 +49,21 @@ All personal data is saved in the [data.json](./src/data.json) file. You can cus
{
"title": "Mix 1",
"cover": "",
"genres": ["Genre 1", "Genre 2, Genre 3"],
"genres": ["Genre 1", "Genre 2", "Genre 3"],
"url": "",
"peaks": ""
},
{
"title": "Mix 2",
"cover": "",
"genres": ["Genre 1", "Genre 2, Genre 3"],
"genres": ["Genre 1", "Genre 2"],
"url": "",
"peaks": ""
},
{
"title": "Mix 3",
"cover": "",
"genres": ["Genre 1", "Genre 2, Genre 3"],
"genres": ["Genre 1", "Genre 2", "Genre 3"],
"url": "",
"peaks": ""
}
Expand Down Expand Up @@ -91,13 +93,13 @@ As this project runs on the client and requires no server setup or configuration

This project uses dropbox to store audio links. To setup, first upload your chosen audio to dropbox. Click share link to generate a link for the file.

Add these links for your audio source and photos in the [data.json](./src/data.json) file.
Add these links for your audio sources, photos, covers and peaks in the [data.json](./src/data.json) file.

### Pre-generated waveforms

If you are planning to host longer audio sources, and are concerned about the performance impact of rendering the waveform on track load, you can instead pre-generate the waveform and serve that data instead.

Wavesurfer.js is used for generating the audio waveforms, they have a guide on how to pre-generate the peaks file required available [here](https://wavesurfer-js.org/faq/).
Wavesurfer.js is used for generating the audio waveforms, they have a guide on how to pre-generate the peaks file required, available [here](https://wavesurfer-js.org/faq/).

## Development

Expand All @@ -118,3 +120,5 @@ npm run build
## Credits

Sample music provided by the [Free Music Archive](https://freemusicarchive.org/music/Marc_Burt/landscapes) and [Mixing.dj](https://mixing.dj/?s=stonebridge).

Icons are open-source and available at [akaricons.com](https://akaricons.com/).
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
{
"name": "dj-profile",
"version": "0.5.0",
"version": "0.8.0",
"private": true,
"description": "A profile for artists/DJ's to promote their music online.",
"author": "Hassan Corrigan <[email protected]>",
"license": "MIT",
"scripts": {
"serve": "vue-cli-service serve",
"build": "vue-cli-service build",
Expand Down

0 comments on commit 942b57e

Please sign in to comment.