Skip to content

Commit

Permalink
updated links
Browse files Browse the repository at this point in the history
  • Loading branch information
rajdip-b committed Jul 7, 2024
1 parent 2deef11 commit 00a23a5
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
6 changes: 3 additions & 3 deletions docs/cli/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Our CLI is one of the major component of keyshade. The CLI is the entrypoint for

The CLI has the following commands:

- [`profile`](./profile.md): This command is used to create, delete, list and switch between profiles.
- [`init`](./init.md): This command is used to initialize your project to tap into the live updates from our platform.
- [`run`](./run.md): This command is used to run your application.
- [profile](./profile.md): This command is used to create, delete, list and switch between profiles.
- [init](./init.md): This command is used to initialize your project to tap into the live updates from our platform.
- [run](./run.md): This command is used to run your application.

## Global flags

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,16 @@ In this section, we will discuss how our codebase is organized. We have tried to

The `apps` directory contains all the applications that are part of the project. Each application is a separate package and has its own `package.json` file. The applications are:

- [**`api`**](../../../apps/api/): The main API server that serves the REST API.
- [**`web`**](../../../apps/web/): The web application that serves the homepage.
- [**`platform`**](../../../apps/workspace/): The platform application hosts the UI that allows users to do the actual work.
- [**api**](../../../apps/api/): The main API server that serves the REST API.
- [**web**](../../../apps/web/): The web application that serves the homepage.
- [**cli**](../../../apps/cli/): The CLI application that allows users to interact with the API and tap into live updates for their application.
- [**platform**](../../../apps/workspace/): The platform application hosts the UI that allows users to do the actual work.

## Packages under `packages` directory

The `packages` directory contains all the shared packages that are used across the applications. These packages are:

- [**`eslint-config-custom`**](../../../packages/eslint-config-custom/): Contains the custom ESLint configuration for the project.
- [**`tsconfig`**](../../../packages/tsconfig/): Contains the custom TypeScript configuration for the project.
- [**eslint-config-custom**](../../../packages/eslint-config-custom/): Contains the custom ESLint configuration for the project.
- [**tsconfig**](../../../packages/tsconfig/): Contains the custom TypeScript configuration for the project.

Apart from the `package.json` files used in the individual packages, we also have a root level `package.json` file that contains the scripts to run the applications and the shared packages. This file also contains the dependencies that are shared across the applications.

0 comments on commit 00a23a5

Please sign in to comment.