Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: create new otter project #2469

Merged
merged 1 commit into from
Nov 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ Also, to customize an application, metadata can be extracted from the applicatio

## Get Started

A new application can be set up with this simple command:
To set up a new Otter project with a monorepo structure, use the following simple command:

```shell
# Starting a new Otter application
npm create @o3r my-app
# Creating a new Otter monorepo
npm create @o3r my-project
```

> [!TIP]
Expand Down
22 changes: 17 additions & 5 deletions docs/core/START_NEW_APPLICATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,25 @@ Start a new Otter application.
* This is used to run tests and generate distributable files. We strongly encourage to use an up-to-date LTS version of Node.js to ensure the support of all the Otter packages.
Each package comes with a minimum Node.js version range defined in the `engine` property of its package.json file.

## Creating a new Otter application
## Creating a new Otter project

```shell
# Create new application
npm create @o3r my-project
# Or
yarn create @o3r my-project
# Or a project using the yarn package manager
npm create @o3r my-project -- --package-manager=yarn
vscaiceanu-1a marked this conversation as resolved.
Show resolved Hide resolved
```

### Generate a new application, library or SDK in the project

Once created, you can generate a new application, library or SDK in the project using the following commands:

```shell
# Application
npm run ng generate application my-webapp
# Library
npm run ng generate library my-library
# SDK
npm run ng generate sdk my-sdk
```

The application will contain the minimum setup to follow the otter recommendations and to activate the features requested
Expand Down Expand Up @@ -61,7 +73,7 @@ to create components and services consistent with your project.
}
```

## Adding Material design theming
### Adding Material design theming

```shell
# Add material design
Expand Down
7 changes: 3 additions & 4 deletions packages/@o3r/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,12 @@ during the installation of the `@o3r/core`.
npm install --global yarn
```

### Creating a new Otter application
### Creating a new Otter project

```shell
# Create new application
npm create @o3r my-project
# Or
yarn create @o3r my-project
# Or a project using the yarn package manager
npm create @o3r my-project -- --package-manager=yarn
```

> [!TIP]
Expand Down
Loading