Skip to content

Commit 258f0e3

Browse files
committed
chore: update readme
1 parent f0f716b commit 258f0e3

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed

README.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
2+
<p align="center"><a href="https://www.discue.io/" target="_blank" rel="noopener noreferrer"><img width="128" src="https://www.discue.io/icons-fire-no-badge-square/web/icon-192.png" alt="Vue logo"></a></p>
3+
4+
# api-docs
5+
discue.io API documentation repository.
6+
7+
## Installation
8+
```bash
9+
git clone https://github.com/discue/api-docs
10+
```
11+
12+
## Development
13+
### Run
14+
Runs and serves the application in development mode.
15+
```bash
16+
./run-dev.sh
17+
```
18+
19+
### Build
20+
Build the application with production mode.
21+
```bash
22+
./build.sh
23+
```
24+
25+
### Releases new patch version
26+
**Release versions must be in sync with API versions.**
27+
28+
```bash
29+
npm run release
30+
```
31+
32+
### Releases new minor version
33+
**Release versions must be in sync with API versions.**
34+
35+
```bash
36+
npm run release-minor
37+
```
38+
39+
### Deploy
40+
Deploy the current state to **production**. Push to branch `deploy`, which will automatically build and deploy the current version to production. Or run ...
41+
42+
```bash
43+
./deploy.sh
44+
```
45+
46+
### Update API Reference
47+
Convert the internal OpenAPI file to VuePress compatible Markdown. **Requires**
48+
```
49+
cd ..
50+
git clone https://github.com/discue/openapi3-to-vuepress2-markdown
51+
git clone https://github.com/discue/discue-io-api
52+
cd api-docs
53+
./generate-api-doc-local.sh
54+
```
55+
56+
## Continuous integration
57+
### Tests
58+
Builds and tests the application whenever a new commit was pushed.
59+
60+
### Releases
61+
Creates a GitHub release whenever a new tag was pushed.
62+
63+
### Deploy
64+
Builds and deploys the application to production whenever branch `deploy` was updated.
65+
66+
### Stale
67+
Closes stale issues and PRs.
68+
69+
## License
70+
71+
[MIT](https://choosealicense.com/licenses/mit/)
72+

0 commit comments

Comments
 (0)