Skip to content
This repository has been archived by the owner on May 31, 2024. It is now read-only.

Commit

Permalink
Remove the client folder
Browse files Browse the repository at this point in the history
  • Loading branch information
abdonrd committed Jun 8, 2020
1 parent e301816 commit 4f3a531
Show file tree
Hide file tree
Showing 37 changed files with 401 additions and 1,526 deletions.
4 changes: 2 additions & 2 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
/client/src-js/
/server/dist/
server/dist/
src-js/
8 changes: 3 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
/client/node_modules/
/client/src-js/
/node_modules/
/server/dist/
/server/node_modules/
node_modules/
server/dist/
src-js/
6 changes: 2 additions & 4 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,2 @@
/client/node_modules/
/client/src-js/
/server/dist/
/server/node_modules/
server/dist/
src-js/
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"editor.formatOnSave": true,
"files.exclude": {
"client/src-js/": true
"src-js/": true
},
"lit-plugin.strict": true
}
62 changes: 29 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,49 +34,45 @@ This command serves the app at `http://localhost:8080`:

npm start

The folder that `es-dev-server` will serve running this command will be `client/src-js/`, a compiled version from TypeScript that will output plain JavaScript, without any transformation from the build process.
The folder that `es-dev-server` will serve running this command will be `src-js/`, a compiled version from TypeScript that will output plain JavaScript, without any transformation from the build process.

### Project structure

```
├─ client/
│ ├─ images/
│ ├─ patches/
│ ├─ src/
│ │ ├─ components/
│ │ │ ├─ app-index.ts
│ │ │ └─ ···
│ │ ├─ config/
│ │ ├─ helpers/
│ │ │ ├─ html-meta-manager/
│ │ │ ├─ page-element.ts
│ │ │ └─ ···
│ │ ├─ pages/
│ │ │ ├─ page-home.ts
│ │ │ └─ ···
│ │ └─ router/
│ │ └─ routes.ts
│ ├─ index.html
│ ├─ manifest.webmanifest
│ └─ package.json
├─ images/
├─ patches/
├─ server/
├─ src/
│ ├─ components/
│ │ ├─ app-index.ts
│ │ └─ ···
│ ├─ config/
│ ├─ helpers/
│ │ ├─ page-element.ts
│ │ └─ ···
│ ├─ pages/
│ │ ├─ page-home.ts
│ │ └─ ···
│ └─ router/
│ └─ routes.ts
├─ index.html
├─ manifest.webmanifest
├─ package.json
├─ robots.txt
├─ rollup.config.js
└─ tsconfig.json
```

- `client`: where you are going to write most of the code of your application.

- `images`: is use to store the static resourced used by your application.
- `patches`: contains the patches to apply in the different packages mentioned [here](#things-to-be-aware). It will be removed at some point.
- `src`
- `components`: contains your custom Web Components. Inside this folder you will find the `app-index.ts` file, main root of your application following the PRPL patern.
- `config`: stores the configuration (handles the environment at the build time).
- `helpers`: contains two interesting features: `PageElement` and `html-meta-manager`. Go more in-depth with them [here](#create-a-new-page).
- `pages`: where you create the pages for your application.
- `routes`: where you create the routes for your application.

- `images`: is use to store the static resourced used by your application.
- `patches`: contains the patches to apply in the different packages mentioned [here](#things-to-be-aware). It will be removed at some point.
- `server`: contains the logic to serve the application. And is where you are going to create your `dist/` folder containing the bundle of your application.
- `src`
- `components`: contains your custom Web Components. Inside this folder you will find the `app-index.ts` file, main root of your application following the PRPL patern.
- `config`: stores the configuration (handles the environment at the build time).
- `helpers`: contains two interesting features: `PageElement` and `html-meta-manager`. Go more in-depth with them [here](#create-a-new-page).
- `pages`: where you create the pages for your application.
- `router`: where you create the routes for your application.
- `index.html`: the application entry point.

## Guides

Expand Down Expand Up @@ -142,6 +138,6 @@ To run on other browsers, you need to use a combination of polyfills and transpi

### Things to be aware

- There is a [patch](client/patches/@vaadin+router+1.7.2.patch) that modifies the `@vaadin/router`'s scroll standard behavior to have a more consistent scroll; now when you perform a `click` event, the scroll will be reset to the top position.
- There is a [patch](patches/@vaadin+router+1.7.2.patch) that modifies the `@vaadin/router`'s scroll standard behavior to have a more consistent scroll; now when you perform a `click` event, the scroll will be reset to the top position.

Related issue: [vaadin/router#43: Restore scroll position on navigation](https://github.com/vaadin/vaadin-router/issues/43)
Loading

0 comments on commit 4f3a531

Please sign in to comment.