-
-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add frozen flag and add troubleshooting + add dependency section
- Loading branch information
1 parent
db49f41
commit c473df0
Showing
4 changed files
with
28 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters