Add development instructions

This commit is contained in:
Maciej Pędzich (Mac) 2023-02-04 01:18:05 +01:00 committed by GitHub
parent 7311a8f02e
commit 3e59671bc6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,2 +1,26 @@
# mackorone-playlist-pr-bot
GitHub bot that automatically verifies PRs with new playlist entries
# playlist-entry-validator
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