Skip to content

Commit

Permalink
docs: update docu
Browse files Browse the repository at this point in the history
  • Loading branch information
deleonio committed Mar 11, 2021
1 parent d4d55c1 commit 72217e3
Show file tree
Hide file tree
Showing 4 changed files with 202 additions and 1 deletion.
4 changes: 4 additions & 0 deletions docs/.vitepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,10 @@ function getGuideSidebar() {
text: 'Guide',
link: '/guide/',
children: [
{
text: 'Showcase',
link: '/guide/showcase/',
},
{
text: 'Installation',
link: '/guide/installation/',
Expand Down
91 changes: 91 additions & 0 deletions docs/assets/demo.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
clear
echo Cleanup demo folder ./$1-$2
sleep 2
rm -rf $1-$2
mkdir $1-$2
cd $1-$2
sleep 3

clear
echo \> npx lup --help
sleep 2
npx lup --help
sleep 3

clear
echo \> npm install --no-save @leanup$3/cli@$2 @leanup$3/cli-$1@$2
sleep 2
npm install --no-save @leanup$3/cli@$2 @leanup$3/cli-$1@$2
sleep 3

clear
echo \> $1 create
sleep 2
npx $1 create
sleep 3

clear
echo \> npm run format -- --write
sleep 2
npm run format -- --write
sleep 3

clear
echo \> npm run lint -- --fix
sleep 2
npm run lint -- --fix
sleep 3

clear
echo \> npx tsc -p tsconfig.json
sleep 2
npx tsc -p tsconfig.json
sleep 3

clear
echo \> npm run test
sleep 2
npm run test
sleep 3

clear
echo \> npm run coverage -- --check-coverage
sleep 2
npm run coverage -- --check-coverage
sleep 3

clear
echo \> npm run build
sleep 2
npm run build
sleep 3

# clear
# echo \> npm start &
# sleep 2
# npm start &
# sleep 30

# clear
# echo \> npm run e2e -- --env=chrome
# sleep 2
# npm run e2e -- --env=chrome
# sleep 3

# clear
# echo \> npm install -D @leanup/cli-cucumber@$2
# sleep 2
# npm install -D @leanup/cli-cucumber@$2
# sleep 3

# clear
# echo \> $1 create
# sleep 2
# $1 create
# sleep 3

# clear
# echo \> npm run cucumber -- --env=chrome
# sleep 2
# npm run cucumber -- --env=chrome
# sleep 3
9 changes: 8 additions & 1 deletion docs/config/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,14 @@ The main legacy bundler is `webpack`. In addition to `webpack`, we have expanded

### Format

We chose `prettier` for the code formatting.
We chose `prettier` for the code formatting with the following configuration:

```js
module.exports = {
printWidth: 120,
singleQuote: true,
};
```

### Lint

Expand Down
99 changes: 99 additions & 0 deletions docs/guide/showcase/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
# Showcase

You can watch a full showcase on you maschine, if you download the following bash script and execute it like this: `sh demo.sh react latest-1.1`

Download: <a href="/1.1/assets/demo.sh" target="leanup-demo-sh">demo.sh</a>

```bash
clear
echo Cleanup demo folder ./$1-$2
sleep 2
rm -rf $1-$2
mkdir $1-$2
cd $1-$2
sleep 3

clear
echo \> npx lup --help
sleep 2
npx lup --help
sleep 3

clear
echo \> npm install --no-save @leanup$3/cli@$2 @leanup$3/cli-$1@$2
sleep 2
npm install --no-save @leanup$3/cli@$2 @leanup$3/cli-$1@$2
sleep 3

clear
echo \> $1 create
sleep 2
npx $1 create
sleep 3

clear
echo \> npm run format -- --write
sleep 2
npm run format -- --write
sleep 3

clear
echo \> npm run lint -- --fix
sleep 2
npm run lint -- --fix
sleep 3

clear
echo \> npx tsc -p tsconfig.json
sleep 2
npx tsc -p tsconfig.json
sleep 3

clear
echo \> npm run test
sleep 2
npm run test
sleep 3

clear
echo \> npm run coverage -- --check-coverage
sleep 2
npm run coverage -- --check-coverage
sleep 3

clear
echo \> npm run build
sleep 2
npm run build
sleep 3

# clear
# echo \> npm start &
# sleep 2
# npm start &
# sleep 30

# clear
# echo \> npm run e2e -- --env=chrome
# sleep 2
# npm run e2e -- --env=chrome
# sleep 3

# clear
# echo \> npm install -D @leanup/cli-cucumber@$2
# sleep 2
# npm install -D @leanup/cli-cucumber@$2
# sleep 3

# clear
# echo \> $1 create
# sleep 2
# $1 create
# sleep 3

# clear
# echo \> npm run cucumber -- --env=chrome
# sleep 2
# npm run cucumber -- --env=chrome
# sleep 3
```

0 comments on commit 72217e3

Please sign in to comment.