mirror of
https://github.com/maciejpedzich/playlist-entry-validator.git
synced 2024-11-27 16:05:48 +01:00
Add development instructions
This commit is contained in:
parent
7311a8f02e
commit
3e59671bc6
28
README.md
28
README.md
@ -1,2 +1,26 @@
|
|||||||
# mackorone-playlist-pr-bot
|
# playlist-entry-validator
|
||||||
GitHub bot that automatically verifies PRs with new playlist entries
|
|
||||||
|
GitHub bot that automatically verifies pull requests with new playlist entries for [spotify-playlist-archive](https://github.com/mackorone/spotify-playlist-archive) repo.
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
|
- Node.js version 18 or later
|
||||||
|
|
||||||
|
### Setup
|
||||||
|
|
||||||
|
(You only need to do this once)
|
||||||
|
|
||||||
|
1. Fork and clone the repo. Then open your command line, `cd` into the project's directory, and run `npm install`
|
||||||
|
2. Follow [this guide](https://probot.github.io/docs/development/#manually-configuring-a-github-app) to create your own GitHub app and configure environment variables
|
||||||
|
|
||||||
|
### Running in dev mode
|
||||||
|
|
||||||
|
```
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT
|
||||||
|
Loading…
Reference in New Issue
Block a user