From 274e3defca242a815813659044b6b3683de525fb Mon Sep 17 00:00:00 2001 From: Sv443 Date: Mon, 21 Oct 2024 00:18:33 +0200 Subject: [PATCH] docs: update funding and contrib guide --- .github/CONTRIBUTING.md | 21 +++++++++++---------- .github/funding.yml | 11 ++--------- 2 files changed, 13 insertions(+), 19 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 990227ac..da818989 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -25,26 +25,27 @@
## Setting up JokeAPI -1. Fork and clone the repository, then run `git clone https://github.com/YourUsername/JokeAPI.git` -2. Check out all submodules with `git submodule update --init --recursive` -3. Install all dependencies with `npm i` -4. Copy the file `.env.template`, rename it to `.env` and fill in the values +1. Install Node.js, Git and pnpm +2. Fork and clone the repository, then run `git clone https://github.com/YourUsername/JokeAPI.git` +3. Check out all submodules with `git submodule update --init --recursive` +4. Install all dependencies with `pnpm i` +5. Copy the file `.env.template` to `.env` and fill in the values
## Running JokeAPI -- Run `npm run dev` to start JokeAPI in development mode and automatically recompile and restart it when you make changes to the code -- Run `npm run start` to build JokeAPI normally and start it in production mode +- Run `pnpm run dev` to start JokeAPI in development mode and automatically recompile and restart it when you make changes to the code +- Run `pnpm run start` to build JokeAPI normally and start it in production mode
## Development commands | Command | Description | | --- | --- | -| `npm run dev` | Starts JokeAPI in development mode and automatically recompiles and restarts it when you make changes to the code | -| `npm run start` | Builds JokeAPI normally and starts it in production mode | -| `npm run lint` | Builds and checks the code for any warnings or errors | -| `npx changeset` | Create new patch notes that will be added to the changelog automatically and trigger the automatic versioning and deployment | +| `pnpm run dev` | Starts JokeAPI in development mode and automatically recompiles and restarts it when you make changes to the code | +| `pnpm run start` | Builds JokeAPI normally and starts it in production mode | +| `pnpm run lint` | Builds and checks the code for any warnings or errors | +

diff --git a/.github/funding.yml b/.github/funding.yml index 7e522661..ba05b2e9 100644 --- a/.github/funding.yml +++ b/.github/funding.yml @@ -1,10 +1,3 @@ -github: Sv443 # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] -patreon: Sv443 -open_collective: # +github: Sv443 ko_fi: Sv443_ -tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel -community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry -liberapay: # Replace with a single Liberapay username -issuehunt: # Replace with a single IssueHunt username -otechie: # Replace with a single Otechie username -custom: ['paypal.me/SvenFehler'] +custom: ['paypal.me/Sv443']