Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lionelvlv authored Oct 2, 2024
1 parent bb036bf commit ab9a8af
Showing 1 changed file with 21 additions and 15 deletions.
36 changes: 21 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,34 @@
# cal.moe

Modernized cal.moe website built with svelte, tailwind and ❤️

## How to contribute
Prerequisite: `git`, `node (preferably by nvm)`, `pnpm`

Prerequisite: `git`, `node (preferrably by nvm)`, `pnpm`

1. Fork the repository
1. Fork the repository or create a new branch
- Both forking and branching are good options for contributing
- Choose the method that best suits your workflow

What's the difference?
- Fork: A fork is a copy of the repository in your own GitHub account. It allows you to freely experiment with changes without affecting the original project.
- Branch: A branch is a separate line of development within the same repository. It's useful for developing features or fixing bugs in isolation without affecting the original project.

2. Clone the repository

- `git clone https://github.com/<YOUR_USERNAME_HERE>/cal.moe.git`
- If you forked: `git clone https://github.com/<YOUR_USERNAME_HERE>/cal.moe.git`
- If you're branching: `git clone https://github.com/original-repo/cal.moe.git`

3. Install packages
- Navigate inside the cloned repository, and run:
`pnpm install`
- Then do:
`npx prisma generate`

- Navigate inside the cloned repository, and run
`pnpm install`
- then do
`npx prisma generate`

4. Make changes and commit to the forked repository

- Tip: to run a development server, run `pnpm run dev` and open `https://localhost:5173` on the web browser of your choice
4. Make changes and commit
- If you forked, commit to your forked repository
- If you branched, commit to your new branch
- Tip: to run a development server, run `pnpm run dev` and open `http://localhost:5173` in your web browser of choice

5. Make a Pull Request
- If you forked, make a PR from your fork to the main repository
- If you branched, make a PR from your branch to the main branch

... and you're good
... and you're good to go!

0 comments on commit ab9a8af

Please sign in to comment.