Skip to content

Commit

Permalink
docs: create new otter project (#2469)
Browse files Browse the repository at this point in the history
## Proposed change

The documentation on creating a new Otter-based project is wrong.
It doesn't specify that the create command actually generates a monorepo
structure.

## Related issues

<!--
Please make sure to follow the [contribution
guidelines](https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md)
-->

*- No issue associated -*

<!-- * 🐛 Fix #issue -->
<!-- * 🐛 Fix resolves #issue -->
<!-- * 🚀 Feature #issue -->
<!-- * 🚀 Feature resolves #issue -->
<!-- * :octocat: Pull Request #issue -->
  • Loading branch information
vscaiceanu-1a authored Nov 15, 2024
2 parents 6cbda67 + 644e76d commit bc1ec49
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 12 deletions.
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
```

### 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

0 comments on commit bc1ec49

Please sign in to comment.