Skip to content

Commit

Permalink
chore: add frozen flag and add troubleshooting + add dependency section
Browse files Browse the repository at this point in the history
  • Loading branch information
IonianPlayboy committed Nov 24, 2024
1 parent db49f41 commit c473df0
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 4 deletions.
26 changes: 25 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,36 @@ If you have [nvm](https://github.com/nvm-sh/nvm), you can run `nvm i` to install
git checkout -b my-new-branch
```

1. Run `pnpm i` in Nimbus's root folder
1. Run `pnpm i --frozen-lockfile` in Nimbus's root folder

2. Run `pnpm nuxi prepare` in Nimbus's root folder

3. Run `pnpm dev` in Nimbus's root folder to start dev server or `pnpm dev:mocked` to start dev server with `@[email protected]` user.

#### Troubleshooting

If you encounter any issues with the installation, we suggest trying the following steps:

- Reinstall the dependencies:

1. Remove the `node_modules` folder in Nimbus's root folder
2. If the `pnpm-lock.yaml` file was modified, revert the changes
3. Retry the installation in the root folder with `pnpm i --frozen-lockfile`

- Check that you are using the correct command to start the dev server:
- `pnpm dev` with `pnpm`

If the issue persists, please open an issue.

#### Adding a new dependency

Since Nimbus is a monorepo using `pnpm` workspace, it's important to add new dependencies using the correct command:

- for development dependencies: `pnpm add -D <dep> -w`
- for production dependencies: `pnpm add <dep> -w`

Alternatively, you can manually add the dependency to the corresponding `package.json` file, and then run `pnpm i` in Nimbus's root folder to install the new dependency.

### Testing

Nimbus uses [Vitest](https://vitest.dev). You can run the test suite with:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ We're really excited that you're interested in contributing to Nimbus! Before su
Clone the repository and run on the root folder:

```
pnpm i
pnpm i --frozen-lockfile
pnpm run dev
```

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ You need the following to contribute to Nimbus's documentation:
1. [Fork the Nimbus GitHub project](https://github.com/nimbus-town/nimbus/fork) into your own account.
2. Clone your fork to your local machine. See [GitHub's instructions for more information](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo#cloning-your-forked-repository).
3. From your terminal, `cd` to the directory you cloned into (`cd nimbus` by default).
4. Run `pnpm i` to install the project dependencies.
4. Run `pnpm i --frozen-lockfile` to install the project dependencies.
5. Run `pnpm --filter nimbus-docs dev` to run the development server.

Once the server has started up, you can access the live preview at <http://localhost:3000/>. This preview reloads when you save changes to the documentation.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/1.guide/3.contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You can use [StackBlitz Codeflow](https://stackblitz.com/codeflow) to fix bugs o
Clone the repository and run on the root folder:

```bash
pnpm i
pnpm i --frozen-lockfile
pnpm run dev
```

Expand Down

0 comments on commit c473df0

Please sign in to comment.