Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md with dev setup for Windows #217

Closed
wants to merge 2 commits into from
Closed

Update README.md with dev setup for Windows #217

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b042e75
Update README.md with dev setup for Windows
nighto Oct 5, 2023
281622b
Update README.md
nighto Oct 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,14 @@ Contributions and suggestions are welcome. Please read the [contribution guideli
To join the translators team, follow the link at the bottom of the language selector in the application ("Want to add your language?").

## Development setup
You'll need [a Last.fm API account](https://www.last.fm/api/account/create)! (and probably a Discogs API key as well)
You'll need [a Last.fm API account](https://www.last.fm/api/account/create)! (and probably a Discogs API key as well). Please note you need to paste the Last.fm API key twice on variables `LASTFM_API_KEY` and `REACT_APP_LASTFM_API_KEY`.
You will also need to install Docker Desktop, and make sure it is running before running trying to run the project.

Windows only: you need to run the development server from within WSL; trying to run with node on Windows directly won't work. [More details on this issue](https://github.com/elamperti/OpenWebScrobbler/issues/216).

* Run `yarn` to download the required libraries.
* Copy `.env` to `.env.development.local` and fill in the required constants.
* Run `yarn start`.

## Testing
You will need to copy `cypress.env.json` to `cypress.development.json` and update the file to execute the tests. Don't use last.fm account credentials from a real account!
Expand Down