Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add open api #360

Merged
merged 2 commits into from
Jan 28, 2023
Merged

docs: add open api #360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d6480a
chore(api): add comment for open api
qwqcode Jan 28, 2023
be818b1
docs: add open api generation support
qwqcode Jan 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,6 @@ yarn-error.log*
node_modules
/ui/**/dist

# docs
/docs/.vitepress/dist/
/docs/.vitepress/cache/

# backend
/artalk.yml
/config.yml
Expand Down
4 changes: 2 additions & 2 deletions .vscode/tasks.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
{
"label": "Build for debugging",
"type": "shell",
"command": "make debug-build",
"command": "make build-debug",
"group": {
"kind": "build",
"isDefault": true
}
}
]
}
}
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ cd Artalk
First, we need to install the dependencies for backend written in Go. Simply run the following command:

```sh
make debug-build
make build-debug
```

This will build both the frontend and backend, with debugging symbols.
Expand Down
3 changes: 3 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ test-coverage:
update-i18n:
go generate ./internal/i18n

update-swagger:
swag init -g server/server.go --output ./docs/swagger

docker-build:
./scripts/docker-build.sh

Expand Down
6 changes: 5 additions & 1 deletion README.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ new Artalk({
pageTitle: 'The title of your page', // Page Title
server: 'http://localhost:8080/api', // Server URL
site: 'Site Name',
i18n: 'en-US'
locale: 'en'
})
```

Expand Down Expand Up @@ -109,6 +109,10 @@ services:
docker-compose up -d
```

## Development

see [CONTRIBUTING.md](./CONTRIBUTING.md)

## Contributors

[![](https://contrib.rocks/image?repo=ArtalkJS/Artalk)](https://github.com/ArtalkJS/Artalk/graphs/contributors)
Expand Down
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,10 @@ services:
docker-compose up -d
```

## Development

see [CONTRIBUTING.md](./CONTRIBUTING.md)

## Contributors

[![](https://contrib.rocks/image?repo=ArtalkJS/Artalk)](https://github.com/ArtalkJS/Artalk/graphs/contributors)
Expand Down
2 changes: 1 addition & 1 deletion conf/artalk.example.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ host: "0.0.0.0"
# Listen port
port: 23366

# App Key (for generation of JWT token)
# App Key (for generation of JWT)
app_key: ""

# Debug mode
Expand Down
3 changes: 3 additions & 0 deletions docs/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/.vitepress/dist/
/.vitepress/cache/
/public/http-api.html
Loading