{"id":15043921,"url":"https://github.com/alljointtw/tonjs","last_synced_at":"2025-04-14T23:12:54.498Z","repository":{"id":40727434,"uuid":"242746598","full_name":"AllJointTW/TonJS","owner":"AllJointTW","description":"The node.js web framework build for ton of request.","archived":false,"fork":false,"pushed_at":"2022-12-10T19:20:59.000Z","size":1852,"stargazers_count":6,"open_issues_count":35,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-14T23:12:48.123Z","etag":null,"topics":["async","await","benchmark","express","fast","hapi","http","koa","light","lightweight","mico","microservice","nest","ton","tonjs","web-framework"],"latest_commit_sha":null,"homepage":"https://tonjs.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AllJointTW.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-24T13:43:02.000Z","updated_at":"2025-03-31T07:35:39.000Z","dependencies_parsed_at":"2023-01-26T07:15:26.685Z","dependency_job_id":null,"html_url":"https://github.com/AllJointTW/TonJS","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllJointTW%2FTonJS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllJointTW%2FTonJS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllJointTW%2FTonJS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllJointTW%2FTonJS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AllJointTW","download_url":"https://codeload.github.com/AllJointTW/TonJS/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248975328,"owners_count":21192210,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["async","await","benchmark","express","fast","hapi","http","koa","light","lightweight","mico","microservice","nest","ton","tonjs","web-framework"],"created_at":"2024-09-24T20:49:49.695Z","updated_at":"2025-04-14T23:12:54.480Z","avatar_url":"https://github.com/AllJointTW.png","language":"TypeScript","readme":"# TonJS\n\n\u003e The node.js web framework build for ton of request.\n\n[![Quality](https://img.shields.io/codacy/grade/03060eb3070e4bab9db9a9751eda056b)](https://www.codacy.com/gh/AllJointTW/TonJS?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=AllJointTW/TonJS\u0026utm_campaign=Badge_Grade) [![Coverage](https://img.shields.io/codacy/coverage/03060eb3070e4bab9db9a9751eda056b)](https://www.codacy.com/gh/AllJointTW/TonJS?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=AllJointTW/TonJS\u0026utm_campaign=Badge_Coverage) ![Testing](https://img.shields.io/github/workflow/status/AllJointTW/TonJS/Testing) ![License](https://img.shields.io/npm/l/@tonjs/ton) ![Version](https://img.shields.io/npm/v/@tonjs/ton) ![Size](https://img.shields.io/bundlephobia/min/@tonjs/ton) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat)](https://github.com/prettier/prettier) ![npm](https://img.shields.io/npm/dw/@tonjs/ton)\n\n## Usage\n\n```sh\n# do something\n```\n\n## Contributing Guide\n\n### Pull Request Guidelines\n\n- Must Follow the [GitHub Flow](https://guides.github.com/introduction/flow/).\n\n- Checkout a topic branch from a base branch, e.g. master, and merge back against that branch.\n\n- If adding a new feature:\n\n  - Add accompanying test case. Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.\n\n- If fixing bug:\n\n  - If you are resolving a special issue, add (fix #xxxx[,#xxxx]) (#xxxx is the issue id) in your PR title for a better release log, e.g. update entities encoding/decoding (fix #3899).\n  - Provide a detailed description of the bug in the PR. Live demo preferred.\n  - Add appropriate test coverage if applicable. You can check the coverage of your code addition by running yarn test --coverage.\n\n- It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging.\n\n- Make sure tests pass!\n\n- Commit messages must follow the [commit message convention](https://www.conventionalcommits.org/en/v1.0.0/) so that changelogs can be automatically generated. Commit messages are automatically validated before commit (by invoking Git Hooks via husky).\n\n- No need to worry about code style as long as you have installed the dev dependencies - modified files are automatically formatted with ESLint and Prettier on commit (by invoking Git Hooks via husky).\n\n- Beware of the git GUI, make sure the husky working fine before you commit.\n  - Sourcetree app on macOS, must open via command line.\n  ```sh\n  open /Applications/Sourcetree.app\n  # or\n  stree folder-name\n  ```\n\n### Prior Knowledge\n\n- lerna (monorepo)\n\n  - https://github.com/lerna/lerna/blob/master/README.md\n  - https://zhuanlan.zhihu.com/p/71385053\n\n- yarn workspace\n\n  - https://classic.yarnpkg.com/en/docs/workspaces\n  - https://classic.yarnpkg.com/en/docs/cli/workspace\n  - https://classic.yarnpkg.com/blog/2018/02/15/nohoist\n\n### Common Scripts\n\n**project**\n\n```sh\n# create the new project\nyarn lerna create project-name\n```\n\n**package**\n\n```sh\n# install all packages\nyarn install\n\n# add the package in whole workspace (root)\nyarn add package-name --ignore-workspace-root-check\n# alternative: yarn add package-name -W\n\n# add the package in special workspace\nyarn workspace workspace-name add package-name\n\n# add the package from another workspace\nyarn workspace workspace-a add workspace-b@version\n# example: yarn workspace @tonjs/bin add @tonjs/ton@0.0.0\n```\n\n**dev**\n\n```sh\n# build the packages first\nyarn build\n\n# dev any ts file\nyarn dev file-name.ts\n```\n\n**format**\n\n```sh\n# format whole workspace (in root)\nyarn format\n```\n\n**lint**\n\n```sh\n# lint the whole workspace (in root)\nyarn lint --fix\n```\n\n**test**\n\n```sh\n# test the code\nyarn test # --coverage --watchAll\n```\n\n**clean**\n\n```sh\n# clean the project\nyarn clean\n```\n\n**build**\n\n```sh\n# build the any project in whole workspace (in root)\nyarn build # or\n# yarn workspaces run build\n```\n\n**release**\n\n```sh\n# tag a version\nyarn lerna version --message \"chore(release): publish\" --create-release github\n\n# publish\nyarn lerna publish from-package\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falljointtw%2Ftonjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falljointtw%2Ftonjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falljointtw%2Ftonjs/lists"}