Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alljointtw/tonjs
The node.js web framework build for ton of request.
https://github.com/alljointtw/tonjs
async await benchmark express fast hapi http koa light lightweight mico microservice nest ton tonjs web-framework
Last synced: 2 months ago
JSON representation
The node.js web framework build for ton of request.
- Host: GitHub
- URL: https://github.com/alljointtw/tonjs
- Owner: AllJointTW
- License: gpl-3.0
- Created: 2020-02-24T13:43:02.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T19:20:59.000Z (about 2 years ago)
- Last Synced: 2024-10-15T00:04:43.330Z (2 months ago)
- Topics: async, await, benchmark, express, fast, hapi, http, koa, light, lightweight, mico, microservice, nest, ton, tonjs, web-framework
- Language: TypeScript
- Homepage: https://tonjs.com
- Size: 1.77 MB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# TonJS
> The node.js web framework build for ton of request.
[](https://www.codacy.com/gh/AllJointTW/TonJS?utm_source=github.com&utm_medium=referral&utm_content=AllJointTW/TonJS&utm_campaign=Badge_Grade) [](https://www.codacy.com/gh/AllJointTW/TonJS?utm_source=github.com&utm_medium=referral&utm_content=AllJointTW/TonJS&utm_campaign=Badge_Coverage)     [](https://github.com/prettier/prettier) 
## Usage
```sh
# do something
```
## Contributing Guide
### Pull Request Guidelines
- Must Follow the [GitHub Flow](https://guides.github.com/introduction/flow/).
- Checkout a topic branch from a base branch, e.g. master, and merge back against that branch.
- If adding a new feature:
- 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.
- If fixing bug:
- 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).
- Provide a detailed description of the bug in the PR. Live demo preferred.
- Add appropriate test coverage if applicable. You can check the coverage of your code addition by running yarn test --coverage.
- It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging.
- Make sure tests pass!
- 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).
- 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).
- Beware of the git GUI, make sure the husky working fine before you commit.
- Sourcetree app on macOS, must open via command line.
```sh
open /Applications/Sourcetree.app
# or
stree folder-name
```
### Prior Knowledge
- lerna (monorepo)
- https://github.com/lerna/lerna/blob/master/README.md
- https://zhuanlan.zhihu.com/p/71385053
- yarn workspace
- https://classic.yarnpkg.com/en/docs/workspaces
- https://classic.yarnpkg.com/en/docs/cli/workspace
- https://classic.yarnpkg.com/blog/2018/02/15/nohoist
### Common Scripts
**project**
```sh
# create the new project
yarn lerna create project-name
```
**package**
```sh
# install all packages
yarn install
# add the package in whole workspace (root)
yarn add package-name --ignore-workspace-root-check
# alternative: yarn add package-name -W
# add the package in special workspace
yarn workspace workspace-name add package-name
# add the package from another workspace
yarn workspace workspace-a add workspace-b@version
# example: yarn workspace @tonjs/bin add @tonjs/[email protected]
```
**dev**
```sh
# build the packages first
yarn build
# dev any ts file
yarn dev file-name.ts
```
**format**
```sh
# format whole workspace (in root)
yarn format
```
**lint**
```sh
# lint the whole workspace (in root)
yarn lint --fix
```
**test**
```sh
# test the code
yarn test # --coverage --watchAll
```
**clean**
```sh
# clean the project
yarn clean
```
**build**
```sh
# build the any project in whole workspace (in root)
yarn build # or
# yarn workspaces run build
```
**release**
```sh
# tag a version
yarn lerna version --message "chore(release): publish" --create-release github
# publish
yarn lerna publish from-package
```