Skip to content

Commit

Permalink
Merge pull request #5 from hyperse-io/feat/track
Browse files Browse the repository at this point in the history
Feat/track
  • Loading branch information
tianyingchun authored Aug 21, 2024
2 parents 96c813e + a8f1477 commit 723b12b
Show file tree
Hide file tree
Showing 9 changed files with 84 additions and 58 deletions.
58 changes: 37 additions & 21 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,21 +1,37 @@
MIT License

Copyright (c) 2024 Hyperse

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
# License
Copyright (C) Hyperse (Yuantai Information Technology (Shanghai) Co., Ltd)

This software is available under two different licenses:
* GNU General Public License version 3 (GPLv3) as Hyperse Community Edition
* Hyperse Commercial License (HCL)

The default Hyperse license, without a valid Hyperse Commercial License agreement, is the Open-Source GPLv3 license.

## GNU General Public License version 3 (GPLv3)

If you decide to choose the GPLv3 license, you must comply with the following terms:

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

## Hyperse Commercial License (HCL)

Alternatively, commercial and supported versions of the program - also known as
Commercial Distributions - must be used in accordance with the terms and conditions
contained in a separate written agreement between you and Hyperse GmbH.
For more information about the Hyperse Commercial License (HCL) please contact hi@hyperse.net.

Please see also:

- [Licensing FAQ - license-faq.md](https://github.com/hyperse-io/.github/blob/main/license/license-faq.md)
- [GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 - gpl-3.0.txt](https://github.com/hyperse-io/.github/blob/main/license/gpl-3.0.txt)
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<a aria-label="Licence" href="https://github.com/hyperse-io/track/blob/main/LICENSE">
<img alt="Licence" src="https://img.shields.io/github/license/hyperse-io/track?style=flat-quare&labelColor=000000" />
</a>
<a aria-label="Discord" href="https://discord.com/invite/tj3ahjXXzM">
<a aria-label="Discord" href="https://www.hyperse.net/community">
<img alt="Discord" src="https://img.shields.io/discord/1249658585227460703?label=Discord&color=5865F2" />
</a>
<a aria-label="Twitter" href="https://x.com/hyperse_net">
Expand Down
4 changes: 2 additions & 2 deletions examples/next-example/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"private": true,
"type": "module",
"scripts": {
"dev": "next dev -p",
"dev": "next dev",
"build": "next build",
"start": "next start",
"lint": "eslint .",
Expand Down Expand Up @@ -33,7 +33,7 @@
"react": "18.2.0",
"react-dom": "18.2.0",
"tailwindcss": "3.3.3",
"typescript": "5.2.2"
"typescript": "5.5.4"
},
"devDependencies": {
"@hyperse/eslint-config-hyperse": "1.1.3",
Expand Down
2 changes: 1 addition & 1 deletion website/copyright.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export const copyrightConfig = `<div class="w-full flex flex-col items-center ju
</a>
<a
class="inline-flex size-10 items-center justify-center rounded-full text-center text-gray-500 transition hover:bg-gray-100 focus:outline-none focus:ring-2 focus:ring-blue-600 focus:ring-offset-2 focus:ring-offset-white dark:text-gray-500 dark:hover:bg-gray-800 dark:hover:text-gray-200"
href="https://discord.com/invite/tj3ahjXXzM"
href="https://www.hyperse.net/community"
target="_blank"
rel="noreferrer"
>
Expand Down
11 changes: 1 addition & 10 deletions website/docs/community/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,16 +89,7 @@ Add any other context or screenshots about the feature request here.

Contributing to projects through a pull request (PR) is a valuable way to improve existing documentation or code. This guide will walk you through the process step by step, ensuring clarity and ease of understanding, especially for those new to GitHub and git operations.

For complex operations, you can also check the [closed pull requests](https://github.com/hyperse-io/track/pulls?q=is%3Apr+is%3Aclosed) for grammar reference. For example,

- [Added Ecosystem Page + Video](https://github.com/hyperse-io/track/pull/392) shows how to add an article with video reference.
- [feat: template example](https://github.com/hyperse-io/track/pull/410) shows how to make use of mdx's feature to create similar pages using template.

:::note

This process does not apply to [TRANSLATIONS](#provide-translation).

:::
For complex operations, you can also check the [closed pull requests](https://github.com/hyperse-io/track/pulls?q=is%3Apr+is%3Aclosed) for grammar reference.

### Local Development for Substantial Changes

Expand Down
34 changes: 34 additions & 0 deletions website/docs/faq.md
Original file line number Diff line number Diff line change
@@ -1 +1,35 @@
# FAQ's

<details>
<summary>Is there any plan for Track to support CommonJS (CJS)?</summary>

Regardless of cjs for the time being. Track is a library based on esm implementation, so that developers do not have a historical burden in the use stage and avoid compatibility problems in the upgrade process

</details>

<details>
<summary>What are the key changes in Track’s new licensing model?</summary>

Track has transitioned to a new licensing model, which impacts how the software can be used, particularly in commercial settings. The new license aims to balance the needs of open-source community use with the commercial sustainability of the project.

This change includes specifics on usage rights, redistribution, and potential costs for commercial entities. More information please see [LICENSE](https://github.com/hyperse-io/track/blob/main/LICENSE)

</details>

<details>
<summary>Do I need to pay for Track now?</summary>

Usually you can use the open source version, This version is for long-term maintenance, which is free of charge.

However we also provide some highly packaged plugins to facilitate rapid business integration, If you use these plug-ins. A small fee is required.

</details>

<details>
<summary>What is Hyperse?</summary>

Hyperse is an open source full stack development suites, front end, architecture, tech solutions, built with TypeScript, GraphQL and Node.js

More information please see [Hyperse](https://www.hyperse.net/)

</details>
4 changes: 2 additions & 2 deletions website/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ const config: Config = {
position: 'right',
},
{
href: 'https://discord.com/invite/tj3ahjXXzM',
href: 'https://www.hyperse.net/community',
label: 'Discord',
position: 'right',
},
Expand Down Expand Up @@ -115,7 +115,7 @@ const config: Config = {
items: [
{
label: 'Discord',
href: 'https://discord.com/invite/tj3ahjXXzM',
href: 'https://www.hyperse.net/community',
},
{
label: 'Twitter',
Expand Down
5 changes: 5 additions & 0 deletions website/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,11 @@ const sidebars: SidebarsConfig = {
},
],
},
{
type: 'link',
label: 'LICENSE',
href: 'https://github.com/hyperse-io/track/blob/main/LICENSE',
},
{
type: 'doc',
id: 'faq',
Expand Down
22 changes: 1 addition & 21 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3287,7 +3287,7 @@ __metadata:
react: "npm:18.2.0"
react-dom: "npm:18.2.0"
tailwindcss: "npm:3.3.3"
typescript: "npm:5.2.2"
typescript: "npm:5.5.4"
languageName: unknown
linkType: soft

Expand Down Expand Up @@ -17911,16 +17911,6 @@ __metadata:
languageName: node
linkType: hard

"typescript@npm:5.2.2":
version: 5.2.2
resolution: "typescript@npm:5.2.2"
bin:
tsc: bin/tsc
tsserver: bin/tsserver
checksum: 10/d65e50eb849bd21ff8677e5b9447f9c6e74777e346afd67754934264dcbf4bd59e7d2473f6062d9a015d66bd573311166357e3eb07fea0b52859cf9bb2b58555
languageName: node
linkType: hard

"typescript@npm:5.5.4, typescript@npm:^5.5.4":
version: 5.5.4
resolution: "typescript@npm:5.5.4"
Expand All @@ -17931,16 +17921,6 @@ __metadata:
languageName: node
linkType: hard

"typescript@patch:typescript@npm%3A5.2.2#optional!builtin<compat/typescript>":
version: 5.2.2
resolution: "typescript@patch:typescript@npm%3A5.2.2#optional!builtin<compat/typescript>::version=5.2.2&hash=f3b441"
bin:
tsc: bin/tsc
tsserver: bin/tsserver
checksum: 10/f79cc2ba802c94c2b78dbb00d767a10adb67368ae764709737dc277273ec148aa4558033a03ce901406b35fddf4eac46dabc94a1e1d12d2587e2b9cfe5707b4a
languageName: node
linkType: hard

"typescript@patch:typescript@npm%3A5.5.4#optional!builtin<compat/typescript>, typescript@patch:typescript@npm%3A^5.5.4#optional!builtin<compat/typescript>":
version: 5.5.4
resolution: "typescript@patch:typescript@npm%3A5.5.4#optional!builtin<compat/typescript>::version=5.5.4&hash=379a07"
Expand Down

0 comments on commit 723b12b

Please sign in to comment.