Skip to content

Commit

Permalink
add prod in ci
Browse files Browse the repository at this point in the history
  • Loading branch information
RSamaium committed Dec 20, 2024
1 parent 35a42cc commit b7e17cd
Show file tree
Hide file tree
Showing 9 changed files with 1,129 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ jobs:
- name: 🧩 Install Dependencies
id: install-dependencies
run: pnpm install
run: pnpm install --prod

- name: 🏗️ Build
id: build-the-mono-repo
Expand Down
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,5 @@ dist-ssr
lib
public
cache
.vitepress
.vitepress/dist
.vitepress/cache
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,19 @@ const onLeave = () => {

## Contributing

Before, install pnpm and run the following command:

```bash
git clone https://github.com/RSamaium/CanvasEngine.git
cd CanvasEngine
npm install
npm run dev
pnpm install
pnpm run dev
```

Documentation

```
cd docs
pnpm install
pnpm run dev
```
8 changes: 5 additions & 3 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { defineConfig } from 'vitepress';

const guideMenu = [
{
text: "Quick Start",
Expand Down Expand Up @@ -51,7 +53,7 @@ const guideMenu = [
},
];

export default {
export default defineConfig({
title: "Canvas Engine Documentation",
description: "Reactive Canvas Framework",
ignoreDeadLinks: true,
Expand All @@ -76,5 +78,5 @@ export default {
"/components/": guideMenu,
"/directives/": guideMenu,
},
},
};
}
})
8 changes: 8 additions & 0 deletions docs/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import DefaultTheme from "vitepress/theme";

export default {
...DefaultTheme,
enhanceApp(ctx) {
DefaultTheme.enhanceApp(ctx);
},
};
46 changes: 44 additions & 2 deletions docs/get_started/installation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,47 @@
# Installation

```bash
npm install canvasengine
```
npx degit RSamaium/CanvasEngine/starter my-project
cd my-project
npm install
npm run dev # and go to localhost:5173
```

Try CanvasEngine


::: sandbox {deps="vue3-toastify: latest"}

```vue App.vue
<template>
<div>
<button @click="notify">Notify !</button>
</div>
</template>
<script setup>
import { toast } from 'vue3-toastify';
const notify = () => {
toast("Wow so easy !", {
autoClose: 1000,
}); // ToastOptions
}
</script>
```

```js /src/main.js [active] [readOnly]
import App from './App.vue';
import { createApp } from 'vue';
import Vue3Toasity from 'vue3-toastify';
import 'vue3-toastify/dist/index.css';

createApp(App).use(
Vue3Toasity,
{
autoClose: 3000,
},
).mount('#app');
```

:::
3 changes: 2 additions & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@
"dependencies": {
"vite": "^6.0.3",
"vitepress": "^1.5.0"
}
},
"type": "module"
}
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@
},
"dependencies": {
"@changesets/cli": "^2.27.10",
"bumpp": "^9.9.1"
"bumpp": "^9.9.1",
"rollup-plugin-node-polyfills": "^0.2.1",
"tsup": "^8.2.4",
"typescript": "^5.6.2"
},
"devDependencies": {
"canvas": "^2.11.2",
"dedent": "^1.5.3",
"eslint": "^8.57.0",
"jsdom": "^25.0.1",
"lightningcss": "^1.28.2",
"rollup-plugin-node-polyfills": "^0.2.1",
"tsup": "^8.2.4",
"typescript": "^5.6.2",
"vite": "^5.4.4",
"vitest": "^1.6.0",
"vitest-webgl-canvas-mock": "^1.1.0"
Expand Down
Loading

0 comments on commit b7e17cd

Please sign in to comment.