Skip to content

Commit

Permalink
docs: update funding and contrib guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Sv443 committed Oct 20, 2024
1 parent ae59339 commit 274e3de
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 19 deletions.
21 changes: 11 additions & 10 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,26 +25,27 @@
<br>

## 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

<br>

## 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

<br>

## 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 |
<!-- TODO: | `pnpx changeset` | Create new patch notes that will be added to the changelog automatically and trigger the automatic versioning and deployment | -->

<br><br>

Expand Down
11 changes: 2 additions & 9 deletions .github/funding.yml
Original file line number Diff line number Diff line change
@@ -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']

0 comments on commit 274e3de

Please sign in to comment.