mnfst · SebConejo · Dec 8, 2022 · Nov 28, 2022 · Nov 28, 2022 · Nov 28, 2022
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,31 @@
+# CASE contribution
+
+Development of reliable and powerful application and ERP. CASE is fully customizable and open to contributions. You can contribute by adding features, reporting bugs or participating in discussions.
+
+> If you are looking for how to install a first project case, go to the [readme](/README.md)
+
+# Development workflow
+
+### 1. Clone the repository
+
+```sh
+git clone [email protected]:case-app/case.git
+```
+
+### 2. Clone the case-starter repository
+
+```sh
+git clone [email protected]:case-app/case-starter.git
+```
+
+### 3. Install the dependencies
+
+First, go to your **CASE-STARTER** repository, and folow instructions from the README.md located at the root of your repository.
+
+Then go to your **CASE** repository and follow the next steps:
+
+1. To work on the client files, go to the `/packages/case-client/` folder and follow the [README-DEV](/packages/case-client/README-DEV.md) instructions
+
+2. To work on schematics, go to the `/packages/schematics/` folder and follow the [README-DEV](/packages/schematics/README-DEV.md) instructions.
+
+3. To work on server files, go to the `/packages/case-server/` folder and follow the [README-DEV](/packages/case-server/README-DEV.md) instructions.
diff --git a/README.md b/README.md
@@ -1,54 +1,65 @@
-# CASE
+<p align="center">
+  <a href="https://www.case.app">
+    <img alt="CASE" src="https://user-images.githubusercontent.com/11723962/163216302-7ceab1a8-19a1-444b-93f7-3d7469ee9986.png" />
+  </a>
+</p>
+<h1 align="center" style="font-weight: bold">
+  CASE
+</h1>
 
-This README would document whatever steps are necessary to get your application up and running.
+CASE allows you to launch a reliable and powerful application or ERP instantly and easily. CASE is fully customizable and open to contributions. You can contribute by adding features, reporting bugs or participating in discussions.
 
-If you need more documentation about the project, please check our full documentation at https://case-app.github.io/docs/#/.
+![screenshot image](./screenshot.png)
 
-CASE is an Open-Source Project, feel free to make as many pull-request as you want to contribute it!
+# Quick start
 
-### Install
+Follow our [quickstart guide](https://docs.case.app) to learn how to set up a CASE project step by step.
 
-Install schematics cli and CASE schematics globally :
+# Getting started
 
-```bash
-sudo npm i -g @angular-devkit/schematics-cli
-```
+1. **Install CASE CLI**
 
-_Note for development :_ Always make sure that you have the latest version of those 2 dependencies with `@latest` as the versions evolve very fast.
+   ```sh
+   npm i -g @case-app/case-cli
+   ```
 
-To run the docs you need to install docsify globally:
+2. **Create a new CASE proejct**
 
-```bash
-npm install docsify-cli --global
-```
+   ```sh
+   case-app new
+   ```
 
-As of today, there is no CLI to crate a new project in one command so you have to clone or download the [CASE source code](https://github.com/case-app/case) and then open your terminal in the CASE root folder for the following steps.
+   During the installation, when the terminal asks you what is the name of your application, just write your application's name and press `Enter`.
 
-```
-npm run case:install
-```
+   The CLI will create a monorepo and install dependencies.
 
-- Create a new DB, you can name it "case" for example
-- Eventually change DB name into `/server/.env`
+3. **Run your project**
 
-### Serve
+   ```sh
+   cd my-case-project
 
-Open 3 terminal windows and run simultaneously :
+   #1st terminal window
+   npm run start:client
 
-- `npm run seed` for create data.
-- `npm run start:client`
-- `npm run start:server`
+   #2nd terminal window
+   npm run start:server
+   ```
 
-Now you can open your browser on `http://localhost:4200`
+   The frontend server will run here => http://localhost:4200
 
-IMPORTANT FOR DEMO : You can connect with the user **[email protected]** with the password **case**
+   The backend server will run here => http://localhost:3000
 
-## Resource
+4. **Seed the data**
 
-CASE allow you to easily build custom web-apps with resources and relations between them.
+   ```sh
+   npm run seed
+   ```
 
-Create resources with this command and follow the instructions in your terminal:
+5. **Got http://localhost:4200/**
+   And Use your CASE admin’s user credentials to log in.
 
-```
-npm run case:resource
-```
+   > You can use the email `[email protected]` and password `case` to log in.
+
+# Deploying to production
+
+...Coming soon
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -1,45 +1,45 @@
-- Getting started
+- 🚀 Getting started
 
-  - [Install](getting-started/install.md)
+  - [Overview](getting-started/overview.md)
+  - [Quick start guide](getting-started/quick-start-guide.md)
   - [Structure](getting-started/structure.md)
   - [Testing](getting-started/testing.md)
 
-- Resources
+- 📖 Resources
 
   - [Create a resource](resources/create-a-resource.md)
   - [Entity file](resources/entity-file.md)
   - [Resource definitions](resources/resource-definitions.md)
   - [Database seeder](resources/database-seeder)
   - [Relations](resources/relations.md)
 
-- Elements
+- 🧱 Elements
 
   - [Inputs](elements/inputs.md)
   - [Top menu quick links](elements/quick-links.md)
   - [Breadcrumbs\*]()
 
-- List view
+- 📋 List view
 
   - [List view](list/list.md)
   - [Filters](list/filters.md)
   - [Yields](list/yields.md)
-  - [Yield types](list/yield-types.md)
   - [Key numbers](list/key-numbers.md)
   - [Action buttons](list/action-buttons.md)
   - [Dropdown links](list/dropdown-links.md)
   - [Calculated columns](list/calculated-columns.md)
   - [Pagination\*]()
 
-- Create-Edit view
+- 📝 Create-Edit view
 
   - [Create-edit view](create-edit/create-edit.md)
-  - [Field types](create-edit/field-types.md)
+  - [Fields](create-edit/field-types.md)
 
-- Detail view
+- 🖥️ Detail view
 
   - [Detail view](detail/detail.md)
 
-- Features
+- 💡 Features
 
   - [Authentication](features/authentication.md)
   - [Roles and permissions](features/roles-and-permissions.md)
@@ -51,8 +51,9 @@
   - [Send emails](features/send-emails.md)
   - [Pipes\*]()
   - [Task scheduling\*](features/task-scheduling.md)
+  - [CLI](features/cli.md)
   - [Notifications\*]()
   - [Generate an Excel/Word/PDF file\*]()
 
-- Theme
+- 🎨 Theme
   - [Customize](theme/customize.md)
diff --git a/docs/assets/images/case-projects.png b/docs/assets/images/case-projects.png
diff --git a/docs/assets/images/introduction/homepage.png b/docs/assets/images/introduction/homepage.png
diff --git a/docs/assets/images/introduction/login-01.png b/docs/assets/images/introduction/login-01.png
diff --git a/docs/assets/images/introduction/login-02.png b/docs/assets/images/introduction/login-02.png
diff --git a/docs/assets/images/introduction/seed.png b/docs/assets/images/introduction/seed.png
diff --git a/docs/assets/images/introduction/seed.svg b/docs/assets/images/introduction/seed.svg
diff --git a/docs/detail/detail.md b/docs/detail/detail.md
@@ -4,56 +4,11 @@
 
 A detail view of a resource is a page (or component) dedicated to the display of the detail of a single item, like profile pages or a single post page.
 
-Let's imagine that you created a **Customer** resource beforehand. Create the detail view component with Angular CLI :
+When you [create a resource](resources/create-a-resource.md), CASE automatically generates the detail view for it.
 
-```bash
-cd client
-ng generate component resources/customer/customer-detail
-```
-
-Add the route to the customer.route.ts :
-
-```js
-  {
-    path: 'customers/:id',
-    component: customerDetailComponent,
-    canActivate: [AuthGuard, PermissionGuard],
-    data: {
-      permission: 'readCustomers',
-    }
-  }
-```
-
-And then extend the `CaseDetailComponent` and initialize the detail view :
-
-```js
-@Component({
-  selector: 'app-customer-detail',
-  templateUrl: './customer-detail.component.html',
-  styleUrls: ['./customer-detail.component.scss']
-})
-export class CustomerDetailComponent
-  extends CaseDetailComponent
-  implements OnInit
-{
-  definition: ResourceDefinition = customerDefinition
-
-  constructor(
-    breadcrumbService: BreadcrumbService,
-    resourceService: ResourceService,
-    flashMessageService: FlashMessageService,
-    activatedRoute: ActivatedRoute
-  ) {
-    super(
-      breadcrumbService,
-      resourceService,
-      flashMessageService,
-      activatedRoute
-    )
-  }
+It the detail view template, you can call your resource properties (if they exist) with the `{{ item.$propName }}` syntax.
 
-  ngOnInit(): void {
-    this.initDetailView()
-  }
-}
+```html
+<h1>{{ item.name }}</h1>
+<p>{{ item.excerpt }}</p>
 ```
diff --git a/docs/features/cli.md b/docs/features/cli.md
@@ -0,0 +1,16 @@
+# CASE CLI
+
+## Install
+
+```
+npm i -g @case-app/case-cli
+```
+
+## Commands
+
+The CASE **Command Line Interface** allows you to interact quickly with case projects.
+
+| Command      | Args                               | Description                   |
+| :----------- | :--------------------------------- | ----------------------------- |
+| **new**      | -                                  | Creates a new CASE project    |
+| **resource** | **name**: the name of the resource | Generates a new CASE resource |
diff --git a/docs/getting-started/install.md b/docs/getting-started/install.md