Skip to content

Commit a9765a5

Browse files
NotKyoyoNotKyoyo
committed
first commit
0 parents  commit a9765a5

File tree

19 files changed

+488
-0
lines changed

19 files changed

+488
-0
lines changed

‎.editorconfig‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# http://editorconfig.org
2+
root = true
3+
4+
[*]
5+
indent_style = space
6+
indent_size = 2
7+
end_of_line = lf
8+
charset = utf-8
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true
11+
12+
[*.md]
13+
trim_trailing_whitespace = false
14+
15+
[Makefile]
16+
indent_style = tab

‎.gitignore‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/npm-debug.log*
6+
/yarn-error.log
7+
/yarn.lock
8+
/package-lock.json
9+
10+
# production
11+
/dist
12+
/docs-dist
13+
14+
# misc
15+
.DS_Store
16+
17+
# umi
18+
.umi
19+
.umi-production
20+
.umi-test
21+
.env.local
22+
23+
# ide
24+
/.vscode
25+
/.idea

‎.prettierignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
**/*.svg
2+
**/*.ejs
3+
**/*.html
4+
package.json
5+
.umi
6+
.umi-production
7+
.umi-test

‎.prettierrc‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"singleQuote": true,
3+
"trailingComma": "all",
4+
"printWidth": 80,
5+
"overrides": [
6+
{
7+
"files": ".prettierrc",
8+
"options": { "parser": "json" }
9+
}
10+
]
11+
}

‎CODE_OF_CONDUCT.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to make participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies within all project spaces, and it also applies when
49+
an individual is representing the project or its community in public spaces.
50+
Examples of representing a project or community include using an official
51+
project e-mail address, posting via an official social media account, or acting
52+
as an appointed representative at an online or offline event. Representation of
53+
a project may be further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at hey.kyoyo@gmail.com or on [Discord](https://discord.gg/yyW389c). All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

‎CONTRIBUTING.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing to Animu
2+
3+
We love your input! We want to make contributing to this project as easy as possible, whether it's:
4+
5+
- Submitting a fix
6+
- Reporting an issue
7+
- Becoming a maintainer
8+
- Proposing new features
9+
- Discussing the current state of the code
10+
11+
## Code of Conduct
12+
13+
The code of conduct is described in [Code of Conduct](CODE_OF_CONDUCT.md).
14+
15+
## Feature Request
16+
17+
Great Feature Requests tend to have:
18+
19+
- A quick idea summary.
20+
- What & why you wanted to add the specific feature.
21+
- Additional context like images, links to resources to implement the feature etc, etc.
22+
23+
## License
24+
25+
By contributing to Animu Documentation, you agree that your contributions will be licensed
26+
under the [LICENSE file](LICENSE.md).

‎README.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Airi Documentation
2+
3+
## Getting Started
4+
5+
Install dependencies,
6+
7+
```bash
8+
$ npm i
9+
```
10+
11+
Start the dev server,
12+
13+
```bash
14+
$ npm run dev
15+
```
16+
17+
Build documentation,
18+
19+
```bash
20+
$ npm run build
21+
```
22+
23+
# Contributing
24+
25+
All contributions are greatly appreciated, but I recommend creating an issue or replying in a comment to let me know what you are working on first that way we don't overwrite each other.
26+
27+
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on this project.
28+
29+
## Issues
30+
31+
- Feature requests/enhancements
32+
- Bug reports
33+
- Questions/feedback
34+
35+
## Branches
36+
37+
- production -> don't touch, this is what's running in production
38+
39+
- staging -> [pull request][pr] this branch for everything
40+
41+
## Pull Requests
42+
43+
All pull requests are welcome!
44+
45+
- [Fork][fork] the repository on GitHub.
46+
47+
- [Clone][cloning] the forked repo to your local machine.
48+
49+
- Do you changes
50+
51+
- Commit your changes
52+
53+
- Push your changes back up to your fork.
54+
55+
- When you're ready, submit a [pull request][pr] so that we can review your changes.
56+
57+
[fork]: https://help.github.com/en/articles/fork-a-repo
58+
[cloning]: https://help.github.com/en/articles/cloning-a-repository
59+
[pr]: https://help.github.com/en/articles/about-pull-requests

‎config/config.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
import { defineConfig } from 'dumi';
2+
3+
export default defineConfig({
4+
title: 'Airi',
5+
favicon: 'https://avatars.githubusercontent.com/u/79479798?s=500&v=4',
6+
logo: 'https://avatars.githubusercontent.com/u/79479798?s=700&v=5',
7+
outputPath: 'docs-dist',
8+
});

‎docs/index.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## Introduction
2+
3+
### Airi API
4+
5+
- Version: `1.0.0`
6+
- Base URL: `https://animu.ml/:endpoint`
7+
- Protocols: `https`
8+
- Responds With: `application/json`
9+
10+
### API rules
11+
12+
> By using the API service you agree to follow the rules of it and will get punished (if abuse) accordingly depending upon the severity of violation.
13+
> All the offence result's permanent ban from using the API
14+
15+
- DDoSing or brute-forcing in any way.
16+
- Mass accounts creation in any way (1 token/person).
17+
- Data scraping.
18+
- Bypassing the rate-limits in any way (15 requests/second). `[TBC]`
19+
- Bypassing the request quote in any way (1000 requests/month). `[TBC]`
20+
- Abusing bugs and not informing to staff in any way.
21+
- Creating flaws in rules and abusing.
22+
> Think it has flaws? Then please let us [know](https://discord.gg/yyW389c). If possible we would change it asap.
23+
24+
### API requirements
25+
26+
- Must have a valid discord account and email.
27+
- Must stay in the support server to keep the token (leaving the server will result your token being reset and you won't receive the new one).
28+
29+
### Frequently asked questions (FAQs)
30+
31+
**How do I get access?**
32+
33+
To get your API token, join this [discord server](https://discord.gg/yyW389c), then type `-claim` in [#bot-commands](https://discord.com/channels/479300008118714388/800784815908454452), fill the questions asked by [@Matsumoto](https://discord.com/channels/@me/834416864766591016) in DM, and receive your token.
34+
35+
**How can you help?**
36+
37+
- Contribute to the [API](https://github.com/AnimuAPI/Animu)
38+
- Donate me via [Ko-fi](https://ko-fi.com/Kyoyo)
39+
- Give feedback or suggestions in [discord server](https://discord.gg/yyW389c).
40+
41+
**Support for API**
42+
43+
Need help? Worry not! A support server is there to help you on discord: https://discord.gg/yyW389c

‎package.json‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{
2+
"private": true,
3+
"name": "airi_docs",
4+
"version": "1.0.0",
5+
"scripts": {
6+
"start": "serve -s docs-dist",
7+
"dev": "dumi dev",
8+
"build": "dumi build",
9+
"prettier": "prettier --write \"**/*.{js,jsx,tsx,ts,less,md,json}\""
10+
},
11+
"main": "dist/index.js",
12+
"module": "dist/index.esm.js",
13+
"typings": "dist/index.d.ts",
14+
"gitHooks": {
15+
"pre-commit": "lint-staged"
16+
},
17+
"lint-staged": {
18+
"*.{js,jsx,less,md,json}": [
19+
"prettier --write"
20+
],
21+
"*.ts?(x)": [
22+
"prettier --parser=typescript --write"
23+
]
24+
},
25+
"dependencies": {
26+
"react": "^16.12.0"
27+
},
28+
"devDependencies": {
29+
"dumi": "^1.0.14",
30+
"lint-staged": "^10.0.7",
31+
"prettier": "^2.2.1",
32+
"serve": "^12.0.0",
33+
"yorkie": "^2.0.0"
34+
}
35+
}

0 commit comments

Comments
 (0)