Skip to content

Commit

Permalink
chore: option to use a gitpod as workspace (freeCodeCamp#959)
Browse files Browse the repository at this point in the history
* chore: use a gitpod as workspace

* fix: correct the typos

* chore: improve descriptions

* fix: improve test instructions
  • Loading branch information
shootermv authored May 13, 2024
1 parent e42e2b7 commit caba804
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# This configuration file was automatically generated by Gitpod.
# Please adjust to your needs (see https://www.gitpod.io/docs/introduction/learn-gitpod/gitpod-yaml)
# and commit this file to your remote git repository to share the goodness with others.

# Learn more from ready-to-use templates: https://www.gitpod.io/docs/introduction/getting-started/quickstart

tasks:
- init: pnpm install && pnpm run build
command: pnpm run start
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ All of the helpful and thoughtful resources are made possible by the generous do

Have a look [here](https://www.freecodecamp.org/news/how-to-donate-to-free-code-camp/) at the different ways you can support our non-profit's mission and make tech education accessible to all.

## How to work on the project using Gitpod

Gitpod is an online environment, where you can work on projects without installing anything on your machine. To setup the Developer Quiz Site with Gitpod, visit this [link](https://gitpod.io/?autostart=true#https://github.com/freeCodeCamp/Developer_Quiz_Site/)

## How to run the project locally

Here are directions on how to fork the freeCodeCamp/Developer_Quiz_Site repository:<br>
Expand All @@ -54,6 +58,12 @@ Make sure to first read through the [Code of Conduct](https://www.freecodecamp.o

Then, read through our [Contributing Documentation](CONTRIBUTING.md).

### How to run the unit tests

Once you are finished making changes, you will need to run the test suite to make sure your code doesn't break anything.
Here is terminal command for running tests: `pnpm test` (or, even shorter: `pnpm t` )
alternativetly (and also cool!) - you can install [vscode vitest extension](https://github.com/vitest-dev/vscode)

### How to report bugs

Found a bug while playing?
Expand Down

0 comments on commit caba804

Please sign in to comment.