docs: add instruction of using gitpod

.gitpod.yml

@@ -0,0 +1,11 @@
+# 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: yarn install && yarn run build
+    command: yarn run start
+
+

CONTRIBUTION.md → CONTRIBUTING.md

@@ -16,6 +16,9 @@ Also! you can look at the project and if you find some point that can be improve
 # Running the Project Locally
 
 Follow these steps to run the project on your local machine:
+0. **GITPOD**
+You can run the project at gitpod.io remote workspace by accessing [this](https://gitpod.io/#https://github.com/hasadna/open-bus-map-git search) url
+
 
 1. **Fork the Repository:**
    Before you clone the repository to your local machine, you need to create a fork of it on GitHub. This allows you to make changes without affecting the original project. To fork the repository, click the "Fork" button at the top right of this page.
@@ -26,27 +29,26 @@ Follow these steps to run the project on your local machine:
    ```bash
    git clone https://github.com/<Your GitHub Username>/open-bus-map-search.git
    ```
-
    Make sure to replace <Your GitHub Username> with your actual GitHub username.
 
 3. **Navigate to the Project Directory:**
-   Once the repository is cloned, navigate to the project directory by running:
-
-   ```bash
-   cd open-bus-map-search
-   ```
+    Once the repository is cloned, navigate to the project directory by running:
 
+    ```bash
+    cd open-bus-map-search
+    ```
 4. **Install Dependencies:**
-   The project uses npm to manage dependencies. Once Node is installed, you can install the project dependencies by running:
-   ```bash
-   npm install
-   ```
+   The project uses Yarn to manage dependencies. If you don't have Yarn installed, you can install it by following the instructions on the [Yarn website](https://classic.yarnpkg.com/en/docs/install). Once Yarn is installed, you can install the project dependencies by running:
+    ```bash
+    yarn
+    ```
 5. **Run the Project:**
-   After all dependencies are installed, you can start the project by running:
-   ```bash
-   npm start
-   ```
-   The project should now be running on your local machine. Open your web browser and navigate to http://localhost:3000 to view the project.
+    After all dependencies are installed, you can start the project by running:
+    ```bash
+    yarn start
+    ```
+    The project should now be running on your local machine. Open your web browser and navigate to http://localhost:3000 to view the project.
+
 
 # How to open the PR
 
@@ -59,6 +61,7 @@ Follow these steps to run the project on your local machine:
 - go to the original repo and create a pr (by pressing `create a pr` button)
 - tag one of the maintainers as reviewers
 
+
 # Commit message convention
 
 - commit messages better to be short and explain clearly what the change is about
@@ -72,13 +75,13 @@ Follow these steps to run the project on your local machine:
 
 ### tests beter to be run locally
 
-| command                | description                                                     |
-| ---------------------- | --------------------------------------------------------------- |
-| `npm run test:unit`    | Run the unit tests using `watch` option (good for development). |
-| `npm run test:unit:ci` | Run the unit tests (good for ci).                               |
-| `npm run test:e2e`     | Run the e2e (playwright) tests (good for ci).                   |
-| `npm run test:e2e:ui`  | Run the e2e (playwright) tests with user interface.             |
-| `npm run test`         | Run all the kind of tests.                                      |
+| command             | description                                                     |
+| ------------------- | --------------------------------------------------------------- |
+| `yarn test:unit`    | Run the unit tests using `watch` option (good for development). |
+| `yarn test:unit:ci` | Run the unit tests (good for ci).                               |
+| `yarn test:e2e`     | Run the e2e (playwright) tests (good for ci).                   |
+| `yarn test:e2e:ui`  | Run the e2e (playwright) tests with user interface.             |
+| `yarn test`         | Run all the kind of tests.                                      |
 
 - additional helpful flags - https://playwright.dev/docs/test-cli
 
@@ -115,7 +118,7 @@ https://open-bus-stride-api.hasadna.org.il/docs
 
 ### Why do I get a red `x` commit status?
 
-- lint - you have lint errors. fix them by running `npm run lint:fix`
-- tests - you have test errors. see them by running `npm run test:unit:ci`
-- build - you have build errors. see them by running `npm run build`
+- lint - you have lint errors. fix them by running `yarn lint:fix`
+- tests - you have test errors. see them by running `yarn test:unit:ci`
+- build - you have build errors. see them by running `yarn build`
 - pr title validation - you have an invalid pr title. please edit the title of your PR with conventional commit formatting. examples: `feat: add new feature`, `fix: fix a bug` or `docs: update README.md`