-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Xinwei Xiong(cubxxw) <[email protected]>
- Loading branch information
Showing
12 changed files
with
39 additions
and
241 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
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
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,5 @@ | ||
| contact_links: | ||
| - name: Connect on slack | ||
| url: https://join.slack.com/t/c-ub/shared_invite/zt-1se0k2bae-lkYzz0_T~BYh3rjkvlcUqQ | ||
| about: Support OpenIM-related requests or issues, get in touch with developers and help on slack | ||
| about: Support kubecub-related requests or issues, get in touch with developers and help on slack | ||
| contact_links: |
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
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
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 |
|---|---|---|
|
|
@@ -358,7 +358,7 @@ Try your best to keep every function has been tested, it keeps the function beha | |
|
|
||
| + [README.md](https://github.com/kubecub/go-project-layout/blob/main/README.md): This file includes the basic information and instructions for getting started with go-project-layout. | ||
| + [CONTRIBUTING.md](https://github.com/kubecub/go-project-layout/blob/main/CONTRIBUTING.md): This file contains guidelines for contributing to go-project-layout's codebase, such as how to submit issues, pull requests, and code reviews. | ||
| + [Official Documentation](nsddd.top): This is the official documentation for go-project-layout, which includes comprehensive information on all of its features, configuration options, and troubleshooting tips. | ||
| + [Official Documentation](https://nsddd.top): This is the official documentation for go-project-layout, which includes comprehensive information on all of its features, configuration options, and troubleshooting tips. | ||
|
|
||
| **Please obey the following rules to better format the docs, which would greatly improve the reading experience.** | ||
|
|
||
|
|
@@ -434,7 +434,7 @@ In addition to Slack, we also offer the following ways to get in touch: | |
| + <a href="https://mail.google.com/mail/u/0/?fs=1&tf=cm&[email protected]" target="_blank"><img src="https://img.shields.io/badge/gmail-%40kubecub-blue?style=social&kubecubo=gmail&logo=gmail"></a>: Get in touch with us on [Gmail]([[email protected]](mailto:[email protected])). If you have any questions or issues that need resolving, or any suggestions and feedback for our open source projects, please feel free to contact us via email. | ||
| + <a href="nsddd.top" target="_blank"><img src="https://img.shields.io/badge/%E5%8D%9A%E5%AE%A2-%40kubecub-blue?style=social&logo=Octopus%20Deploy&logoColor=red"></a>: Read our [kubecub](nsddd.top). Our kubecub is a great place to stay up-to-date with kubecub projects and trends. On the kubecub, we share our latest developments, tech trends, and other interesting information. | ||
| + <a href="https://nsddd.top" target="_blank"><img src="https://img.shields.io/badge/%E5%8D%9A%E5%AE%A2-%40kubecub-blue?style=social&logo=Octopus%20Deploy&logoColor=red"></a>: Read our [kubecub](https://nsddd.top). Our kubecub is a great place to stay up-to-date with kubecub projects and trends. On the kubecub, we share our latest developments, tech trends, and other interesting information. | ||
| + <a href="https://twitter.com/xxw3293172751" target="_blank"><img src="https://img.shields.io/badge/twitter-%40kubecub-informational?kubecubo=twitter&style=flat-square&logo=twitter"></a> : Add [Twitter]({twitter}) . If you prefer social media, our Twitter account is a great way to stay up-to-date with kubecub project news and trends. On Twitter, we share our latest tech and trends, as well as relevant news and events. | ||
|
|
||
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,106 +1,8 @@ | ||
| # go-project-layout | ||
| # `/api` | ||
|
|
||
| <h1 align="center" style="border-bottom: none"> | ||
| <b> | ||
| <a href="https://docker.nsddd.top">go-project-layout</a><br> | ||
| </b> | ||
| ⭐️ ESG Tracker: Automated Disclosure Monitoring ⭐️ <br> | ||
| </h1> | ||
| OpenAPI/Swagger specs, JSON schema files, protocol definition files. | ||
|
|
||
| <p align=center> | ||
| <a href="https://goreportcard.com/report/github.com/kubecub/go-project-layout"><img src="https://goreportcard.com/badge/github.com/kubecub/go-project-layout" alt="A+"></a> | ||
| <a href="https://github.com/issues?q=org%3Akubecub+is%3Aissue+label%3A%22good+first+issue%22+no%3Aassignee"><img src="https://img.shields.io/github/issues/kubecub/go-project-layout/good%20first%20issue?logo=%22github%22" alt="good first"></a> | ||
| <a href="https://github.com/kubecub/go-project-layout"><img src="https://img.shields.io/github/stars/kubecub/go-project-layout.svg?style=flat&logo=github&colorB=deeppink&label=stars"></a> | ||
| <a href="https://join.slack.com/t/kubecub/shared_invite/zt-1se0k2bae-lkYzz0_T~BYh3rjkvlcUqQ"><img src="https://img.shields.io/badge/Slack-100%2B-blueviolet?logo=slack&logoColor=white"></a> | ||
| <a href="https://github.com/kubecub/go-project-layout/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-green"></a> | ||
| <a href="https://golang.org/"><img src="https://img.shields.io/badge/Language-Go-blue.svg"></a> | ||
| </p> | ||
| Examples: | ||
|
|
||
| </p> | ||
|
|
||
| <p align="center"> | ||
| <a href="./README.md"><b>English</b></a> • | ||
| <a href="./README_zh-CN.md"><b>中文</b></a> | ||
| </p> | ||
|
|
||
| </p> | ||
|
|
||
| ## Awesome features | ||
|
|
||
| A system that monitors and tracks ESG (Environmental, Social and Governance) disclosures and ratings from various public data sources. It collects ESG data points from sources like Feishu spreadsheets and makes them available through an administrative interface. | ||
|
|
||
| ## Quickstart | ||
|
|
||
| > **Note**: You can get started quickly with go-project-layout. | ||
|
|
||
| ## Contributing & Development | ||
|
|
||
| kubecub Our goal is to build a top-level open source community. We have a set of standards, in the [Community repository](https://github.com/kubecub/community). | ||
|
|
||
| If you'd like to contribute to this go-project-layout repository, please read our [contributor documentation](https://github.com/kubecub/go-project-layout/blob/main/CONTRIBUTING.md). | ||
|
|
||
|
|
||
| ## architecture diagram | ||
| ```mermaid | ||
| graph LR | ||
| subgraph External Services | ||
| feishuAPI --> sheetParser | ||
| end | ||
| subgraph Sheet Parser & Manager | ||
| sheetParser[Sheet Parser] --> versionControl | ||
| versionControl[Version Control] --> sheetDisplay | ||
| end | ||
| subgraph Display | ||
| sheetDisplay[Sheet Display] --> UI | ||
| end | ||
| subgraph Backend | ||
| versionControl --> API | ||
| end | ||
| subgraph Frontend | ||
| UI[User Interface] | ||
| end | ||
| API --> UI | ||
| UI --> feishuAPI | ||
| ``` | ||
|
|
||
| **MVC Architecture Design:** | ||
| ```mermaid | ||
| graph LR | ||
| A[View] -->|1. User interaction| B(Controller) | ||
| B -->|2. Requests data| C(Model) | ||
| C -->|3. Returns data| B | ||
| B -->|4. Updates view| A | ||
| ``` | ||
|
|
||
| ## File Directory Description | ||
|
|
||
|
|
||
|
|
||
| ## community meeting | ||
|
|
||
| We welcome everyone to join us and contribute to go-project-layout, whether you are new to open source or professional. We are committed to promoting an open source culture, so we offer community members neighborhood prizes and reward money in recognition of their contributions. We believe that by working together, we can build a strong community and make valuable open source tools and resources available to more people. So if you are interested in go-project-layout, please join our community and start contributing your ideas and skills! | ||
|
|
||
| We take notes of each [biweekly meeting](https://github.com/kubecub/go-project-layout/issues/2) in [GitHub discussions](https://github.com/kubecub/go-project-layout/discussions/categories/meeting), and our minutes are written in [Google Docs](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing). | ||
|
|
||
| go-project-layout maintains a [public roadmap](https://github.com/kubecub/community/tree/main/roadmaps). It gives a a high-level view of the main priorities for the project, the maturity of different features and projects, and how to influence the project direction. | ||
|
|
||
|
|
||
| ## License | ||
|
|
||
| Sealer is licensed under the Apache License, Version 2.0. See [LICENSE](https://github.com/kubecub/go-project-layout/tree/main/LICENSE) for the full license text. | ||
|
|
||
| [](https://app.fossa.com/projects/git%2Bgithub.com%2Fkubecub%2Fgo-project-layout?ref=badge_large) | ||
|
|
||
|
|
||
| ## Thanks to our contributors! | ||
|
|
||
| <a href="https://github.com/kubecub/go-project-layout/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=kubecub/go-project-layout" /> | ||
| </a> | ||
| * https://github.com/kubernetes/kubernetes/tree/master/api | ||
| * https://github.com/moby/moby/tree/master/api |
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
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
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
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
Oops, something went wrong.