Skip to content

Commit ab0a8c8

Browse files
adcenturyadcentury
committed
Initialize project
0 parents  commit ab0a8c8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

95 files changed

+79707
-0
lines changed

‎.editconfig

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# http://editorconfig.org
2+
root = true
3+
4+
[*]
5+
charset = utf-8
6+
end_of_line = lf
7+
indent_size = 2
8+
indent_style = space
9+
insert_final_newline = true
10+
trim_trailing_whitespace = true

‎.github/ISSUE_TEMPLATE/bug-report.yml

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Bug Report
2+
description: Create a bug report to help us improve
3+
labels: ["bug", "needs: triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: Thanks for taking the time to file a bug report! Please fill out this form as completely as possible.
8+
- type: dropdown
9+
id: os
10+
attributes:
11+
label: What operating system are you using?
12+
options:
13+
- Mac
14+
- Windows
15+
- Linux
16+
- Other
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: bug-desctiption
21+
attributes:
22+
label: Describe the bug
23+
description: A clear and concise description of the bug. If you intent to submit a PR for this issue, tell us in the description.
24+
placeholder: I am doing ... What I expect is ... What actually happening is ...
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: steps-to-reproduce
29+
attributes:
30+
label: Steps to reproduce
31+
description: Please provide the steps to reproduce the behavior. Screenshots can be provided in the issue body below.
32+
validations:
33+
required: true
34+
- type: input
35+
id: reproduction-link
36+
attributes:
37+
label: Reproduction Link
38+
description: Include a link to a repository that reproduces the problem you ran into. This is optional, but increases the likelihood that we can help you!
39+
validations:
40+
required: false
41+
- type: markdown
42+
attributes:
43+
value: Before posting the issue go through the steps you've written down to make sure the steps provided are detailed and clear.

‎.github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Discord Chat
4+
url: https://discord.gg/YhypQrZBu5
5+
about: Chat with other Documate users in real time
6+
- name: Ask a question
7+
url: https://github.com/AirCodeLabs/documate/discussions
8+
about: Ask questions and discuss ideas in GitHub discussions

‎.github/ISSUE_TEMPLATE/feature-request.yml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Feature Request
2+
description: Create a feature request
3+
labels: ["enhancement", "needs: triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: Thanks for your interest in the project and taking the time to file a feature request! Please fill out this for as completely as possible.
8+
- type: textarea
9+
id: feature-description
10+
attributes:
11+
label: Feature Description
12+
description: A clear and concise description of what you want and what your use case is. If you intent to submit a PR for this issue, tell us in the desciption. Thanks!
13+
placeholder: As a developer using Documate, I want ... so that ...
14+
validations:
15+
required: ture
16+
- type: textarea
17+
id: suggested-solution
18+
attributes:
19+
label: Suggested Solution
20+
description: A clear and concise description of what you want to happen.
21+
placeholder: In ..., we could provide the following implementation ...
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: alternative
26+
attributes:
27+
label: Alternative
28+
description: A clear and concise description of any alternative solutions or features you've considered.
29+
validations:
30+
required: false
31+
- type: textarea
32+
id: additional-comments
33+
attributes:
34+
label: Additional comments
35+
description: Any other background/context about the feature request here.
36+
validations:
37+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<!-- Thank you for contributing! -->
2+
3+
### Description
4+
5+
<!-- Write a short summary of what this PR is solving. If necessary, include relevant screenshorts. -->

‎.github/workflows/deploy-doc-site.yaml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Deploy Doc Site
2+
env:
3+
VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
4+
VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
5+
on:
6+
push:
7+
branches:
8+
- main
9+
paths:
10+
- docs/**
11+
jobs:
12+
Deploy-Production:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v3
16+
- uses: pnpm/action-setup@v2
17+
with:
18+
version: 8.6.6
19+
- uses: actions/setup-node@v3
20+
with:
21+
node-version: 18.x
22+
cache: pnpm
23+
cache-dependency-path: docs/pnpm-lock.yaml
24+
- name: Install Vercel CLI
25+
run: pnpm i -g vercel@latest
26+
- name: Build Project and Deploy to Vercel
27+
working-directory: ./docs
28+
run: |
29+
vercel pull --yes --environment=production --token=${{ secrets.VERCEL_DEPLOY_TOKEN }}
30+
vercel build --prod --token=${{ secrets.VERCEL_DEPLOY_TOKEN }}
31+
vercel deploy --prebuilt --prod --token=${{ secrets.VERCEL_DEPLOY_TOKEN }}

‎.gitignore

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
node_modules
5+
**/node_modules
6+
7+
# misc
8+
.DS_Store
9+
*.pem
10+
.cache
11+
12+
# debug
13+
npm-debug.log*
14+
yarn-debug.log*
15+
yarn-error.log*

‎CODE_OF_CONDUCT.md

+132
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[INSERT CONTACT METHOD].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Contributing to Documate
2+
3+
Thanks for your interest in contributing to Documate! Please take a moment to review this document __before submitting a pull request__.
4+
5+
- [Code of Conduct](https://github.com/AirCodeLabs/aircode/blob/main/CODE_OF_CONDUCT.md)
6+
- [Pull Requests](#pull-requests)
7+
- [Development Setup](#development-setup)
8+
9+
## Pull Requests
10+
11+
Before starting work on any significant new features, please create [an issue](https://github/aircodelabs/documate/issues) to first discuss it. If you are making changes to the UI components, make sure to update both the Vue and React versions so that we can ensure feature parity.
12+
13+
- Checkout a topic branch from the relevant branch, and merge back against that branch.
14+
- If adding a new feature, please link to a corresponding issue in the PR description.
15+
- If fixing a bug, please provide a detailed description of the bug in the PR description. Live demo preferred.
16+
17+
## Development Setup
18+
19+
We use [pnpm](https://pnpm.io/) as the package manager. You need to install it before proceeding.
20+
21+
### Installation
22+
23+
After cloning the repo, cd into the corresponding directory and run `pnpm install` to install the dependencies.
24+
25+
```bash
26+
pnpm install
27+
```
28+
29+
### Running Dev Server
30+
31+
You can start the dev server by running the following command:
32+
33+
```bash
34+
pnpm run dev
35+
```

0 commit comments

Comments
 (0)