# Acode **Repository Path**: wang-tian-feng/Acode ## Basic Information - **Project Name**: Acode - **Description**: Android系统上的IDE工具 https://github.com/Acode-Foundation/Acode - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2024-12-21 - **Last Updated**: 2024-12-21 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Acode - Code Editor for Android
Acode/ | |- src/ - Core code and language files | |- www/ - Public documents, compiled files, and HTML templates | |- utils/ - CLI tools for building, string manipulation, and more## • Multi-language Support Enhance Acode's capabilities by adding new languages easily. Just create a file with the language code (e.g., en-us for English) in [`src/lang/`](https://github.com/Acode-Foundation/Acode/tree/main/src/lang) and include it in [`src/lib/lang.js`](https://github.com/Acode-Foundation/Acode/blob/main/src/lib/lang.js). Manage strings across languages effortlessly using utility commands: ```shell yarn lang add yarn lang remove yarn lang search yarn lang update ``` ## • Building the Application To build the APK, ensure you have Node.js, NPM, and Apache Cordova installed on your device. Use Cordova CLI to build the application. 1. Initial setup (required only once): ```shell yarn setup ``` 2. Build the project: ```shell yarn build
```
## • Contributing
Acode Editor is an open-source project, and we welcome contributions from the community. To contribute, follow these steps:
1. Fork the repository.
2. Make your changes and commit them.(make branch for each feature or bug fix)
3. Push your changes to your fork.
4. Create a pull request from your branch to main branch of this repository with proper description and Wait for review.
> [!Note]
> Ensure your pull request includes:
> - A clear description of the changes made or problem or feature.
> - A reference to the issue being addressed (if applicable).
> - A clear explanation of the solution or implementation.
> - Screenshots or GIFs (if applicable).
Please ensure that your code is clean, well-formatted, and follows the project's coding standards. Acode uses [Biomejs](https://biomejs.dev/) for formatting and linting and [typos](https://github.com/crate-ci/typos) for low false positives source code spell checking. You can use following commands to lints/format your code locally:
```shell
yarn lint # for linting
yarn format # for formatting
yarn check # it runs both lint and format
```
Also, ensure that your code is well-documented and includes comments where necessary.
> [!Note]
> You can use any package manager like npm or yarn or pnpm or bun.
> You can use your editor specific Biomejs plugin for auto-formatting and linting based on Acode's configs.
## • Contributors
## • Developing a Plugin for Acode
For comprehensive documentation on creating plugins for Acode Editor, visit the [repository](https://github.com/Acode-Foundation/acode-plugin).
For plugin development information, refer to: [Acode Plugin Documentation](https://acode.app/plugin-docs)
## Star History