-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feature(root): Add readme and related files (#36)
- Loading branch information
Showing
6 changed files
with
294 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# .editorconfig | ||
|
||
# Top-most EditorConfig file | ||
root = true | ||
|
||
# Default settings for all files | ||
[*] | ||
charset = utf-8 | ||
end_of_line = lf | ||
insert_final_newline = true | ||
indent_style = space | ||
indent_size = 2 | ||
tab_width = 2 | ||
trim_trailing_whitespace = true | ||
|
||
# Override settings for specific file types | ||
[*.md] | ||
trim_trailing_whitespace = false | ||
|
||
[*.yml] | ||
indent_style = space | ||
indent_size = 2 | ||
|
||
[*.json] | ||
indent_style = space | ||
indent_size = 2 | ||
|
||
[*.js] | ||
indent_style = space | ||
indent_size = 2 | ||
|
||
[*.ts] | ||
indent_style = space | ||
indent_size = 2 | ||
|
||
[*.css] | ||
indent_style = space | ||
indent_size = 2 | ||
|
||
[*.html] | ||
indent_style = space | ||
indent_size = 2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# .gitattributes | ||
|
||
# See https://github.com/github/linguist#vendored-code | ||
demos/* | ||
|
||
# Set the default behavior for line endings, to always use LF | ||
* text=auto eol=lf | ||
|
||
# Specify binary files, so Git doesn't try to modify them | ||
*.png binary | ||
*.jpg binary | ||
*.jpeg binary | ||
*.gif binary | ||
*.ico binary | ||
*.pdf binary | ||
*.zip binary | ||
*.gz binary | ||
|
||
# Define files that should always use CRLF line endings | ||
*.bat text eol=crlf | ||
|
||
# Define files that should always use LF line endings | ||
*.sh text eol=lf | ||
|
||
# Define custom merge strategies for specific files or file types | ||
*.json merge=ours |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Documentation | ||
# https://help.github.com/en/articles/about-code-owners | ||
|
||
* @adcentury @wangxiao @0xinhua | ||
/.github/workflows @adcentury @0xinhua | ||
/demos/ @wangxiao | ||
/docs/ @adcentury |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,132 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
We as members, contributors, and leaders pledge to make participation in our | ||
community a harassment-free experience for everyone, regardless of age, body | ||
size, visible or invisible disability, ethnicity, sex characteristics, gender | ||
identity and expression, level of experience, education, socio-economic status, | ||
nationality, personal appearance, race, caste, color, religion, or sexual | ||
identity and orientation. | ||
|
||
We pledge to act and interact in ways that contribute to an open, welcoming, | ||
diverse, inclusive, and healthy community. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to a positive environment for our | ||
community include: | ||
|
||
* Demonstrating empathy and kindness toward other people | ||
* Being respectful of differing opinions, viewpoints, and experiences | ||
* Giving and gracefully accepting constructive feedback | ||
* Accepting responsibility and apologizing to those affected by our mistakes, | ||
and learning from the experience | ||
* Focusing on what is best not just for us as individuals, but for the overall | ||
community | ||
|
||
Examples of unacceptable behavior include: | ||
|
||
* The use of sexualized language or imagery, and sexual attention or advances of | ||
any kind | ||
* Trolling, insulting or derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or email address, | ||
without their explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Enforcement Responsibilities | ||
|
||
Community leaders are responsible for clarifying and enforcing our standards of | ||
acceptable behavior and will take appropriate and fair corrective action in | ||
response to any behavior that they deem inappropriate, threatening, offensive, | ||
or harmful. | ||
|
||
Community leaders have the right and responsibility to remove, edit, or reject | ||
comments, commits, code, wiki edits, issues, and other contributions that are | ||
not aligned to this Code of Conduct, and will communicate reasons for moderation | ||
decisions when appropriate. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all community spaces, and also applies when | ||
an individual is officially representing the community in public spaces. | ||
Examples of representing our community include using an official e-mail address, | ||
posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported to the community leaders responsible for enforcement at | ||
[INSERT CONTACT METHOD]. | ||
All complaints will be reviewed and investigated promptly and fairly. | ||
|
||
All community leaders are obligated to respect the privacy and security of the | ||
reporter of any incident. | ||
|
||
## Enforcement Guidelines | ||
|
||
Community leaders will follow these Community Impact Guidelines in determining | ||
the consequences for any action they deem in violation of this Code of Conduct: | ||
|
||
### 1. Correction | ||
|
||
**Community Impact**: Use of inappropriate language or other behavior deemed | ||
unprofessional or unwelcome in the community. | ||
|
||
**Consequence**: A private, written warning from community leaders, providing | ||
clarity around the nature of the violation and an explanation of why the | ||
behavior was inappropriate. A public apology may be requested. | ||
|
||
### 2. Warning | ||
|
||
**Community Impact**: A violation through a single incident or series of | ||
actions. | ||
|
||
**Consequence**: A warning with consequences for continued behavior. No | ||
interaction with the people involved, including unsolicited interaction with | ||
those enforcing the Code of Conduct, for a specified period of time. This | ||
includes avoiding interactions in community spaces as well as external channels | ||
like social media. Violating these terms may lead to a temporary or permanent | ||
ban. | ||
|
||
### 3. Temporary Ban | ||
|
||
**Community Impact**: A serious violation of community standards, including | ||
sustained inappropriate behavior. | ||
|
||
**Consequence**: A temporary ban from any sort of interaction or public | ||
communication with the community for a specified period of time. No public or | ||
private interaction with the people involved, including unsolicited interaction | ||
with those enforcing the Code of Conduct, is allowed during this period. | ||
Violating these terms may lead to a permanent ban. | ||
|
||
### 4. Permanent Ban | ||
|
||
**Community Impact**: Demonstrating a pattern of violation of community | ||
standards, including sustained inappropriate behavior, harassment of an | ||
individual, or aggression toward or disparagement of classes of individuals. | ||
|
||
**Consequence**: A permanent ban from any sort of public interaction within the | ||
community. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
version 2.1, available at | ||
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. | ||
|
||
Community Impact Guidelines were inspired by | ||
[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. | ||
|
||
For answers to common questions about this code of conduct, see the FAQ at | ||
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at | ||
[https://www.contributor-covenant.org/translations][translations]. | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html | ||
[Mozilla CoC]: https://github.com/mozilla/diversity | ||
[FAQ]: https://www.contributor-covenant.org/faq | ||
[translations]: https://www.contributor-covenant.org/translations |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,62 @@ | ||
<p align="center"> | ||
<img src="https://user-images.githubusercontent.com/1651946/226520122-0017adb6-68cd-4382-9fa0-649676e10932.png#gh-light-mode-only" alt="AirCode" /> | ||
<img src="https://user-images.githubusercontent.com/1651946/226520130-7df56d95-0582-49aa-bdb5-87c63b974f72.png#gh-dark-mode-only" alt="AirCode" /> | ||
</p> | ||
|
||
<p align="center"> | ||
Build intelligent bots with Node.js, remarkably fast. | ||
</p> | ||
|
||
--- | ||
|
||
# AirCode | ||
|
||
https://aircode.io | ||
[AirCode](https://aircode.io) is an online platform designed to streamline the development and deployment of Node.js applications, tailored for full-stack engineers. | ||
|
||
With an intuitive in-browser IDE and pre-configured cloud services, we takes care of the backend technology selection, environment setup, and operation, so you can focus on building great products. No more complex setup processes, no more headaches over server management - open your browser, and you're ready to go. | ||
|
||
## Getting Started | ||
|
||
To get started with AirCode, follow our [Quick Start](https://docs.aircode.io/getting-started/) guide. | ||
|
||
## Documentation | ||
|
||
For a comprehensive understanding of AirCode's features and capabilities, visit our [Documentation](https://docs.aircode.io) page. | ||
|
||
## Tutorials | ||
|
||
To get a better understanding of how AirCode can be used in real-world applications, check out this tutorial on [connecting Siri to ChatGPT in just 5 minutes](https://aircode.cool/hpwdi7n719). | ||
|
||
## Community and Support | ||
|
||
Need help or want to connect with other AirCode users? Check out these community and support resources: | ||
|
||
- [GitHub Issues](https://github.com/aircodelabs/aircode/issues): Report bugs, request features, or ask questions about AirCode. | ||
- [Discord](https://discord.com/invite/XrMVdYdEuY): Join our Discord community to chat with other users, get help, and share your experiences with AirCode. | ||
- [Email Support](https://docs.aircode.io/help): Reach out to our team directly for assistance through email. | ||
|
||
## Project Directories | ||
|
||
- `docs`: Contains the source files for AirCode's documentation, including guides, tutorials, and API references. | ||
- `demos`: A collection of demo applications and examples showcasing the capabilities of AirCode and how to use the platform effectively. | ||
- `website`: The source code for the AirCode website, including the landing page, blog, and other related pages. | ||
- `dashboard`: The source code for AirCode's web-based dashboard, where users can manage their applications, deployments, and account settings. | ||
- `sdk`: The Software Development Kit (SDK) for AirCode, which includes libraries and tools to help developers integrate their applications with the AirCode platform. | ||
|
||
## Contributing | ||
|
||
We welcome contributions to any of these projects! To contribute, follow these steps: | ||
|
||
1. Fork the repository on GitHub. | ||
2. Clone your fork and create a new branch for your feature or bugfix. | ||
3. Navigate to the appropriate folder for the project you wish to contribute to. | ||
4. Make your changes, ensuring that they adhere to the project's coding standards and guidelines. | ||
5. Commit your changes and push them to your fork. | ||
6. Open a pull request against the main repository, describing the changes you've made and any additional context that might be helpful. | ||
|
||
Please note that by contributing to this project, you agree to abide by the Code of Conduct and any other guidelines established by the project maintainers. | ||
|
||
## References | ||
|
||
AirCode Open Source | ||
- [Code of Conduct](./CODE_OF_CONDUCT.md) | ||
- [Apache 2.0 License](./LICENSE) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
{ | ||
"name": "aircode-monorepo", | ||
"description": "Build intelligent bots with Node.js, remarkably fast.", | ||
"version": "0.0.0", | ||
"private": true, | ||
"workspaces": [ | ||
"docs", | ||
"demos/*", | ||
"website", | ||
"dashboard", | ||
"sdk" | ||
], | ||
"repository": { | ||
"type": "git", | ||
"url": "git+https://github.com/aircodelabs/aircode.git" | ||
}, | ||
"engines": { | ||
"node": ">=16.0.0" | ||
}, | ||
"keywords": [ | ||
"aircode", | ||
"functions", | ||
"database", | ||
"storage", | ||
"serverless", | ||
"cloud" | ||
] | ||
} |