create-zuplo-api 6.59.13 → 6.59.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1,11 +1,45 @@
|
|
|
1
1
|
# Developer Portal
|
|
2
2
|
|
|
3
|
-
This is your
|
|
4
|
-
|
|
3
|
+
This is your
|
|
4
|
+
[Zuplo Developer Portal](https://zuplo.com/docs/dev-portal/introduction). This
|
|
5
|
+
developer portal allows you to ship a beautiful API documentation for your
|
|
5
6
|
users. You can customize this portal to match your brand and style.
|
|
6
7
|
|
|
7
8
|
This developer portal is configured to work with your Zuplo API. When you
|
|
8
9
|
publish your API, your developer portal will be automatically published with the
|
|
9
10
|
latest API documentation.
|
|
10
11
|
|
|
11
|
-
For more information, visit the
|
|
12
|
+
For more information, visit the
|
|
13
|
+
[Documentation](https://zuplo.com/docs/dev-portal/introduction).
|
|
14
|
+
|
|
15
|
+
The Zuplo Developer Portal is built on top of the open source
|
|
16
|
+
[Zudoku](https://zudoku.dev) project, a powerful tool for creating and managing
|
|
17
|
+
API documentation. If you would like to learn more about the project, open a
|
|
18
|
+
feature request, or contribute to the codebase, visit the
|
|
19
|
+
[Zudoku GitHub repository](https://github.com/zuplo/zudoku).
|
|
20
|
+
|
|
21
|
+
## Local Development
|
|
22
|
+
|
|
23
|
+
After you have connected your Zuplo project to
|
|
24
|
+
[source control](https://zuplo.com/docs/articles/source-control) you can clone
|
|
25
|
+
your project locally. Running the Developer Portal locally allows you to see
|
|
26
|
+
changes in real-time with live-reload.
|
|
27
|
+
|
|
28
|
+
1. Clone the repository
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
git clone https://github.com/my-org/my-repo
|
|
32
|
+
cd my-repo
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
2. Install dependencies
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
npm install
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
3. Start the development server
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
npm run docs
|
|
45
|
+
```
|
|
@@ -1,11 +1,45 @@
|
|
|
1
1
|
# Developer Portal
|
|
2
2
|
|
|
3
|
-
This is your
|
|
4
|
-
|
|
3
|
+
This is your
|
|
4
|
+
[Zuplo Developer Portal](https://zuplo.com/docs/dev-portal/introduction). This
|
|
5
|
+
developer portal allows you to ship a beautiful API documentation for your
|
|
5
6
|
users. You can customize this portal to match your brand and style.
|
|
6
7
|
|
|
7
8
|
This developer portal is configured to work with your Zuplo API. When you
|
|
8
9
|
publish your API, your developer portal will be automatically published with the
|
|
9
10
|
latest API documentation.
|
|
10
11
|
|
|
11
|
-
For more information, visit the
|
|
12
|
+
For more information, visit the
|
|
13
|
+
[Documentation](https://zuplo.com/docs/dev-portal/introduction).
|
|
14
|
+
|
|
15
|
+
The Zuplo Developer Portal is built on top of the open source
|
|
16
|
+
[Zudoku](https://zudoku.dev) project, a powerful tool for creating and managing
|
|
17
|
+
API documentation. If you would like to learn more about the project, open a
|
|
18
|
+
feature request, or contribute to the codebase, visit the
|
|
19
|
+
[Zudoku GitHub repository](https://github.com/zuplo/zudoku).
|
|
20
|
+
|
|
21
|
+
## Local Development
|
|
22
|
+
|
|
23
|
+
After you have connected your Zuplo project to
|
|
24
|
+
[source control](https://zuplo.com/docs/articles/source-control) you can clone
|
|
25
|
+
your project locally. Running the Developer Portal locally allows you to see
|
|
26
|
+
changes in real-time with live-reload.
|
|
27
|
+
|
|
28
|
+
1. Clone the repository
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
git clone https://github.com/my-org/my-repo
|
|
32
|
+
cd my-repo
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
2. Install dependencies
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
npm install
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
3. Start the development server
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
npm run docs
|
|
45
|
+
```
|