Skip to content

Commit

Permalink
feat: migrate to pnpm shyamtawli#148 (shyamtawli#152)
Browse files Browse the repository at this point in the history
* feat: migrate to pnpm shyamtawli#148

* docs: change docs according to pnpm shyamtawli#148

* deleted

* Update CONTRIBUTING.md
  • Loading branch information
priyankarpal authored May 12, 2023
1 parent 05aeae3 commit e2c8ecc
Show file tree
Hide file tree
Showing 6 changed files with 10,351 additions and 17,259 deletions.
18 changes: 15 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,24 @@ To contribute to devFind, you will need to have Node.js and Git installed on you
Once you have installed these dependencies, you can clone the devFind repository to your local machine by running the following command in your terminal:

git clone https://github.com/devFind-io/devFind.git

## **Install `pnpm`**

To install `pnpm` use this command.

npm install -g pnpm

## **Install dependencies**

Navigate to the project folder on your terminal and install the dependencies using:

npm install
pnpm install

## **Run the application**

Run the following command to start the application:

pnpm start

## **Create a new branch**

Expand All @@ -30,7 +42,7 @@ Now that you have set up your environment and created a new branch, you can star

Before submitting your changes, it is important to test them thoroughly to make sure they work as expected. Run the following command to test the application:

npm test
pnpm test

This will run all the tests in the project and give you feedback on any failures.

Expand All @@ -57,4 +69,4 @@ Your pull request will be reviewed by other contributors to ensure it meets the

## **Merge your changes**

Once your pull request is approved and passes all tests, it can be merged into the main codebase. Congratulations, you have successfully contributed to devFind!
Once your pull request is approved and passes all tests, it can be merged into the main codebase. Congratulations, you have successfully contributed to devFind!
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

1. Fork the repository to create a copy in your GitHub account.
2. Clone the forked repository to your local development environment.
3. Install dependencies by running **`npm install`**
3. Install dependencies & run using **`pnpm install`** & **`pnpm start`**.
4. Navigate to the **`src/data`** directory.
5. Open the **`Profile.json`** file.
6. Add your profile data in the JSON object format, following the existing structure:
Expand Down Expand Up @@ -67,4 +67,4 @@ Contributions make the open source community such an amazing place to learn, ins
## Support 🙏

Thank you for contributing to our open-source project! We appreciate your support 🚀 <br>
Don't forget to leave a star
Don't forget to leave a star
Loading

0 comments on commit e2c8ecc

Please sign in to comment.