Skip to content

Commit 2ebe8f1

Browse files
authored
Merge pull request #3 from elsiosanchez/feature/add-install
Add Docs File Get Started
2 parents 2a93744 + 863d77c commit 2ebe8f1

File tree

17 files changed

+439
-66
lines changed

17 files changed

+439
-66
lines changed

docs/.vuepress/navbar/en.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@ import { navbar } from "vuepress-theme-hope";
22

33
export const enNavbar = navbar([
44
{ text: "Get Started", icon: "rocket", link: "/get-started/" },
5-
{ text: "Guia", icon: "signs-post", link: "/guide/" },
5+
{ text: "Guide", icon: "book-open", link: "/guide/" },
66
]);

docs/.vuepress/navbar/es.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ import { navbar } from "vuepress-theme-hope";
33
export const esNavbar = navbar([
44
"/es/",
55
{ text: "Empezar", icon: "rocket", link: "/es/get-started/" },
6-
{ text: "Guia", icon: "signs-post", link: "/es/guide/" },
6+
{ text: "Guia", icon: "book-open", link: "/es/guide/" },
77
]);
Loading

docs/.vuepress/public/box.svg

+1
Loading

docs/.vuepress/sidebar/en.ts

+53-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,58 @@ import { sidebar } from "vuepress-theme-hope";
33
export const enSidebar = sidebar({
44
"/": [
55
"",
6-
"get-started/",
6+
// "get-started/",
7+
// {
8+
// text: "指南",
9+
// icon: "lightbulb",
10+
// prefix: "guide/",
11+
// children: [
12+
// "intro/",
13+
// "interface/",
14+
// "layout/",
15+
// "markdown/",
16+
// "feature/",
17+
// "blog/",
18+
// "customize/",
19+
// "advanced/",
20+
// ],
21+
// },
22+
// {
23+
// text: "配置",
24+
// icon: "gears",
25+
// prefix: "config/",
26+
// children: [
27+
// "intro",
28+
// "i18n",
29+
// "theme/",
30+
// "plugins/",
31+
// "frontmatter/",
32+
// "style",
33+
// ],
34+
// },
35+
// {
36+
// text: "教程",
37+
// icon: "signs-post",
38+
// prefix: "cookbook/",
39+
// children: ["markdown/", "vuepress/"],
40+
// },
41+
{
42+
text: "Get Started",
43+
link: "get-started/",
44+
icon: "rocket",
45+
children: [
46+
"get-started/Develop/",
47+
"get-started/Build/",
48+
"get-started/Docker/"
49+
]
50+
},
51+
{ text: "Guide", icon: "book-open", link: "/guide/" },
52+
// "get-started/",
53+
// {
54+
// text: "Get Started",
55+
// icon: "rocket",
56+
// prefix: "get-started/",
57+
// children: "structure",
58+
// }
759
],
860
});

docs/.vuepress/sidebar/es.ts

+10-5
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,15 @@ export const esSidebar = sidebar({
44
"/es/": [
55
"",
66
{
7-
text: "Documentación",
8-
icon: "signs-post",
9-
prefix: "docs/",
10-
children: "structure",
11-
}
7+
text: "Empezar",
8+
link: "get-started/",
9+
icon: "rocket",
10+
children: [
11+
"get-started/Develop/",
12+
"get-started/Build/",
13+
"get-started/Docker/"
14+
]
15+
},
16+
{ text: "Guide", icon: "book-open", link: "/guide/" },
1217
],
1318
});

docs/.vuepress/theme.ts

+1
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,7 @@ export default hopeTheme({
169169
attrs: true,
170170
codetabs: true,
171171
component: true,
172+
alert: true,
172173
demo: true,
173174
figure: true,
174175
imgLazyload: true,

docs/README.md

+35-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ actions:
1212
type: primary
1313

1414
- text: Guide
15-
icon: signs-post
15+
icon: book-open
1616
link: /guide/
1717

1818
# - text: Demos
@@ -112,4 +112,37 @@ actions:
112112

113113
copyright: false
114114
footer: MIT Licensed | Copyright © 2019-present Mr.Hope
115-
---
115+
---
116+
117+
ADempiere-Vue is a new UI for ADempiere ERP, CRM & SCM. It is based on Vue<i class="fa-brands fa-vuejs" style="color: #63E6BE;"></i> , Nuxt and uses the UI Toolkit Element-Plus. It is a great UI for ADempiere ERP, CRM & SCM, based on the newest development stack of Vue, built-in i18n solution, typical templates for enterprise applications, lots of awesome features. This project was forked from Vue-Element-Admin
118+
<!--
119+
## 🚀Usage
120+
121+
::: code-tabs#language
122+
123+
@tab TS
124+
125+
```ts title=".vuepress/config.ts"
126+
import { defineUserConfig } from "vuepress";
127+
import { hopeTheme } from "vuepress-theme-hope";
128+
129+
export default defineUserConfig({
130+
theme: hopeTheme({
131+
// your theme config here
132+
}),
133+
});
134+
```
135+
136+
@tab JS
137+
138+
```js title=".vuepress/config.js"
139+
import { hopeTheme } from "vuepress-theme-hope";
140+
141+
export default {
142+
theme: hopeTheme({
143+
// your theme config here
144+
}),
145+
};
146+
```
147+
148+
::: -->

docs/es/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ actions:
1212
type: primary
1313

1414
- text: Guia
15-
icon: signs-post
15+
icon: book-open
1616
link: /guide/
1717

1818
# features:
@@ -110,3 +110,4 @@ copyright: false
110110
footer: MIT Licensed | Copyright © 2019-present Mr.Hope
111111
---
112112

113+
ADempiere-Vue es una nueva interfaz de usuario para ADempiere ERP, CRM y SCM. Se basa en Vue<i class="fa-brands fa-vuejs" style="color: #63E6BE;"></i>, Nuxt y utiliza el UI Toolkit Element-Plus. Es una gran interfaz de usuario para ADempiere ERP, CRM y SCM, basado en la pila de desarrollo más reciente de Vue, solución i18n incorporada, plantillas típicas para aplicaciones empresariales, un montón de características impresionantes. Este proyecto fue bifurcado de Vue-Element-Admin

docs/es/get-started/Build/README.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Modo Producción
3+
icon: gears
4+
star: true
5+
sticky: 10
6+
dir:
7+
order: 1
8+
category:
9+
- Cookbook
10+
- Tutorial
11+
- Get Started
12+
- Build
13+
---
14+
15+
Una vez finalizados los proyectos, puedes compilar tu aplicación con sólo ejecutar un comando
16+
17+
::: code-tabs#shell
18+
19+
@tab npm
20+
21+
```bash
22+
23+
# Instalar Dependencia (npm install --frozen-lockfile)
24+
npm install
25+
26+
27+
# Construye
28+
npm run build
29+
```
30+
31+
@tab yarn
32+
33+
```bash
34+
35+
# Instalar Dependencia (yarm install --frozen-lockfile)
36+
yarm
37+
38+
# Construye
39+
yarm run build
40+
```
41+
:::
42+
43+
Después de que el paquete de construcción tiene éxito, la carpeta dist se generará en el directorio raíz, que es construir un archivo empaquetado, por lo general los archivos estáticos como **.js, .css, index.html, etc .**

docs/es/get-started/Develop/README.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: Modo Desarrollo
3+
icon: screwdriver-wrench
4+
star: true
5+
sticky: 10
6+
dir:
7+
order: 3
8+
category:
9+
- Cookbook
10+
- Tutorial
11+
- Get Started
12+
- Install
13+
---
14+
15+
16+
## 🛠 Primeros Pasos
17+
18+
::: code-tabs#shell
19+
20+
@tab npm
21+
22+
```bash
23+
24+
# Introduzca el Directorio del Proyecto
25+
cd frontend-core
26+
27+
# Instalar Dependencia
28+
npm ci
29+
30+
# Ejecute el Proyecto como Desarrollo
31+
npm dev
32+
```
33+
34+
@tab yarn
35+
36+
```bash
37+
# Introduzca el Directorio del Proyecto
38+
cd frontend-core
39+
40+
# Instalar Dependencia
41+
yarm ci
42+
43+
# Ejecute el Proyecto como Desarrollo
44+
yarm run dev
45+
46+
```
47+
:::
48+
49+
Esto abrirá automáticamente [localhost:9527](http://localhost:9527)

docs/es/get-started/Docker/README.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Docker
3+
icon: clone
4+
star: true
5+
sticky: 10
6+
dir:
7+
order: 1
8+
category:
9+
- Cookbook
10+
- Tutorial
11+
- Get Started
12+
- Docker
13+
---
14+
## <i class="fa-brands fa-docker" style="color: #74C0FC;" /> Ejecutar contenedor docker
15+
16+
### Requisitos mínimos de Docker
17+
18+
Para utilizar esta imagen Docker debe tener su motor Docker número de versión mayor o igual a 3.0.
19+
Crear imagen Docker (solo para desarrollo):
20+
21+
22+
```bash
23+
docker build -t solopcloud/adempiere-vue:dev -f ./Dockerfile .
24+
```
25+
26+
### Descargar imagen docker:
27+
28+
```bash
29+
docker pull solopcloud/adempiere-vue
30+
```
31+
32+
### Ejecutar contenedor contenedor:
33+
34+
```bash
35+
docker run -it \
36+
--name adempiere-vue \
37+
-p 80:80 \
38+
-e API_URL="http://localhost:9527/api/" \
39+
-e TZ="America/Caracas" \
40+
solopcloud/adempiere-vue
41+
```
42+
43+
### O ejecute fácilmente el contenedor utilizando docker-compose con el siguiente comando:
44+
45+
```bash
46+
docker-compose up
47+
```

docs/es/get-started/README.md

+24-23
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Empezar
3-
icon: signs-post
3+
icon: rocket
44
star: true
55
sticky: 10
66
dir:
@@ -14,39 +14,40 @@ category:
1414

1515
Este proyecto es una solución front-end lista para producción para interfaces de administración. Está basado en [Vue](https://vuejs.org/), [Nuxt](https://nuxt.com/) y utiliza el kit de interfaz de usuario [Element Plus](https://element-plus.org/).
1616

17-
## 🛠 Primeros pasos
17+
## 🛠 Clonar el Projecto
1818

19-
::: code-tabs#shell
19+
:::: info Clone the Project
2020

21-
@tab npm
21+
<FontIcon icon="file-code" /> **Instalar frontend-core**:
2222

23-
```bash
24-
# Clonar el Projecto
25-
git clone https://github.com/adempiere/adempiere-vue.git
26-
27-
# Instalar las Dependencia
28-
npm install
23+
::: tabs#shell
2924

30-
# Modo Desarrollo
31-
npm run dev
25+
@tab Usando HTTPS
3226

33-
# Modo Producción
34-
npm run build
27+
```bash
28+
https://github.com/solop-develop/frontend-core.git
3529
```
30+
Clonar usando la URL web.
31+
32+
@tab Usando SHH
33+
34+
> [!important]
35+
> No tienes ninguna clave SSH pública en tu cuenta de GitHub. Puede [agregar una nueva clave pública](https://github.com/settings/ssh/new) o intentar clonar este repositorio a través de HTTPS.
3636
37-
@tab yarn
3837

3938
```bash
40-
# Clonar el Projecto
41-
git clone https://github.com/adempiere/adempiere-vue.git
39+
[email protected]:solop-develop/frontend-core.git
40+
```
41+
42+
Utilice una clave SSH protegida con contraseña.
4243

43-
# Instalar las Dependencia
44-
yarm
4544

46-
# Modo Desarrollo
47-
yarm run dev
45+
@tab:active GitHub CLI
4846

49-
# Modo Producción
50-
yarm run build
47+
```bash
48+
gh repo clone solop-develop/frontend-core
5149
```
50+
Trabaje rápido con nuestra CLI oficial. [Aprende más](https://cli.github.com/)
5251
:::
52+
53+
::::

0 commit comments

Comments
 (0)