Add README, DCO, CONTRIBUTING and .github files
This commit is contained in:
Corteza Monorepo Migrator
parent
683c7c56e2
commit
6fcc565cc5
19
.editorconfig
Normal file
19
.editorconfig
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
# EditorConfig is awesome: https://EditorConfig.org
|
||||||
|
|
||||||
|
# top-most EditorConfig file
|
||||||
|
root = true
|
||||||
|
|
||||||
|
[*]
|
||||||
|
end_of_line = lf
|
||||||
|
insert_final_newline = true
|
||||||
|
|
||||||
|
[*.go]
|
||||||
|
indent_style = space
|
||||||
|
|
||||||
|
[*.cue]
|
||||||
|
indent_style = space
|
||||||
|
indent_size = 2
|
||||||
|
|
||||||
|
# Tab indentation (no size specified)
|
||||||
|
[Makefile]
|
||||||
|
indent_style = tab
|
||||||
10
.gitattributes
vendored
Normal file
10
.gitattributes
vendored
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
server/**/*gen.go linguist-generated=true
|
||||||
|
server/**/*gen_test.go linguist-generated=true
|
||||||
|
|
||||||
|
server/vendor/** linguist-vendored=true
|
||||||
|
server/go.mod linguist-vendored=true
|
||||||
|
server/go.sum linguist-vendored=true
|
||||||
|
|
||||||
|
server/docs/*.yaml linguist-documentation=true
|
||||||
|
server/docs/README.adoc linguist-documentation=true
|
||||||
|
server/docs/index.html linguist-documentation=true
|
||||||
9
.gitignore
vendored
Normal file
9
.gitignore
vendored
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
.DS_Store
|
||||||
|
.idea
|
||||||
|
.vscode
|
||||||
|
*.iml
|
||||||
|
*.suo
|
||||||
|
*.ntvs*
|
||||||
|
*.njsproj
|
||||||
|
*.sln
|
||||||
|
*.sw*
|
||||||
69
CONTRIBUTING.md
Normal file
69
CONTRIBUTING.md
Normal file
@ -0,0 +1,69 @@
|
|||||||
|
# Contributing
|
||||||
|
|
||||||
|
Thank you for helping us make [our vision](https://cortezaproject.org/about/what-is-corteza/) a reality!
|
||||||
|
All contributions are welcome; from bug reports, codefixes, and new features!
|
||||||
|
|
||||||
|
## Ground Rules
|
||||||
|
|
||||||
|
Corteza projects are [Apache 2.0 licensed](LICENSE) and accept contributions via GitHub pull requests.
|
||||||
|
|
||||||
|
Cover the [terminology](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/release-cycle/index.html#_terminology) for the development process and versioning.
|
||||||
|
|
||||||
|
Cover the [Git and GitHub](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/release-cycle/index.html#_github) ground rules regarding branch naming and conventions.
|
||||||
|
|
||||||
|
When you wish to start working on a code contribution, assign yourself to a GitHub issue.
|
||||||
|
If there is no issue, create one beforehand.
|
||||||
|
|
||||||
|
A quick summary on [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/):
|
||||||
|
|
||||||
|
1. Separate subject from body with a blank line
|
||||||
|
2. Limit the subject line to 50 characters
|
||||||
|
3. Capitalize the subject line
|
||||||
|
4. Do not end the subject line with a period
|
||||||
|
5. Use the imperative mood in the subject line
|
||||||
|
6. Wrap the body at 72 characters
|
||||||
|
7. Use the body to explain what and why vs. how
|
||||||
|
|
||||||
|
## Core repositories
|
||||||
|
|
||||||
|
### Corteza Server
|
||||||
|
|
||||||
|
Corteza server is the back-end of the Corteza ecosystem.
|
||||||
|
The core logic is written in GO, using [go-chi](https://pkg.go.dev/github.com/go-chi/chi@v3.3.4+incompatible?utm_source=gopls) for the routing.
|
||||||
|
|
||||||
|
Communication between the Corteza server and web applications is done using the REST API and web sockets.
|
||||||
|
Communication between back-end services (Corteza server and Corredor) is done using gRPC.
|
||||||
|
|
||||||
|
The [Developer Guide/Corteza Server](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/corteza-server/index.html) covers the [development setup](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/corteza-server/index.html#_development_setup), the [project structure](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/corteza-server/structure.html), and the feature insight documents.
|
||||||
|
|
||||||
|
|
||||||
|
### Corteza Web Applications
|
||||||
|
|
||||||
|
The web applications are written in Vue.js and provide the user interface to interact with the entire system.
|
||||||
|
|
||||||
|
Communication between the Corteza server and web applications is done using the REST API and web sockets.
|
||||||
|
|
||||||
|
The [Developer Guide/Corteza Web Applications](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/web-applications/index.html) covers the [development setup](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/web-applications/index.html#_development_setup), the [project structure](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/web-applications/structure.html), and the feature insight documents.
|
||||||
|
|
||||||
|
### Documentation
|
||||||
|
|
||||||
|
The documentation is written in [AsciiDoc](https://asciidoc.org/) and compiled using [Antora](https://antora.org/).
|
||||||
|
The source code is available on the [GitHub cortezaproject/corteza-docs repository](https://github.com/cortezaproject/corteza-docs); the generated output is available on the [documentation page](http://docs.cortezaproject.org/).
|
||||||
|
|
||||||
|
The [Developer Guide/Documentation](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/documentation/index.html) covers the [conventions](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/documentation/index.html#_conventions), [writing guidelines](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/documentation/index.html#documentation-writing-guidelines), as well as some [examples](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/documentation/examples/index.html) to help you get started.
|
||||||
|
|
||||||
|
## Bug reporting
|
||||||
|
|
||||||
|
Please submit any bug reports on the **issues** section of the corresponding GitHub repository.
|
||||||
|
If you are unsure where to submit the issue, or you are unsure if this is a feature; reach out to us on [our forum](https://forum.cortezaproject.org/).
|
||||||
|
|
||||||
|
## Feature requests
|
||||||
|
|
||||||
|
Feature and improvement requests should be submitted on [our forum](https://forum.cortezaproject.org/).
|
||||||
|
Before opening a new topic, search around to see if there are any similar topics that would cover your case.
|
||||||
|
|
||||||
|
## DCO
|
||||||
|
|
||||||
|
By contributing to this project you agree to the Developer Certificate of Origin (DCO).
|
||||||
|
This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution.
|
||||||
|
See the [DCO](DCO) file for details.
|
||||||
36
DCO
Normal file
36
DCO
Normal file
@ -0,0 +1,36 @@
|
|||||||
|
Developer Certificate of Origin
|
||||||
|
Version 1.1
|
||||||
|
|
||||||
|
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
|
||||||
|
660 York Street, Suite 102,
|
||||||
|
San Francisco, CA 94110 USA
|
||||||
|
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies of this
|
||||||
|
license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
|
||||||
|
Developer's Certificate of Origin 1.1
|
||||||
|
|
||||||
|
By making a contribution to this project, I certify that:
|
||||||
|
|
||||||
|
(a) The contribution was created in whole or in part by me and I
|
||||||
|
have the right to submit it under the open source license
|
||||||
|
indicated in the file; or
|
||||||
|
|
||||||
|
(b) The contribution is based upon previous work that, to the best
|
||||||
|
of my knowledge, is covered under an appropriate open source
|
||||||
|
license and I have the right under that license to submit that
|
||||||
|
work with modifications, whether created in whole or in part
|
||||||
|
by me, under the same open source license (unless I am
|
||||||
|
permitted to submit under a different license), as indicated
|
||||||
|
in the file; or
|
||||||
|
|
||||||
|
(c) The contribution was provided directly to me by some other
|
||||||
|
person who certified (a), (b) or (c) and I have not modified
|
||||||
|
it.
|
||||||
|
|
||||||
|
(d) I understand and agree that this project and the contribution
|
||||||
|
are public and that a record of the contribution (including all
|
||||||
|
personal information I submit with it, including my sign-off) is
|
||||||
|
maintained indefinitely and may be redistributed consistent with
|
||||||
|
this project or the open source license(s) involved.
|
||||||
202
LICENSE
Normal file
202
LICENSE
Normal file
@ -0,0 +1,202 @@
|
|||||||
|
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright [yyyy] [name of copyright owner]
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
111
README.md
Normal file
111
README.md
Normal file
@ -0,0 +1,111 @@
|
|||||||
|
<h1 align="center">
|
||||||
|
<img width="300px" src=".github/assets/corteza_logo.svg" />
|
||||||
|
<br />
|
||||||
|
<p>Corteza Low Code Platform</p>
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
[](https://img.shields.io/docker/pulls/cortezaproject/corteza)
|
||||||
|
[](https://img.shields.io/github/v/tag/cortezaproject/corteza?label=stable%20version)
|
||||||
|
[](https://img.shields.io/github/license/cortezaproject/corteza)
|
||||||
|
|
||||||
|
[](https://goreportcard.com/report/github.com/cortezaproject/corteza)
|
||||||
|
[](https://img.shields.io/codecov/c/github/cortezaproject/corteza)
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</h1>
|
||||||
|
|
||||||
|
<br />
|
||||||
|
|
||||||
|
**Corteza server** is the **back-end** of the Corteza ecosystem.
|
||||||
|
The core logic is written in GO, using [go-chi](https://pkg.go.dev/github.com/go-chi/chi@v3.3.4+incompatible?utm_source=gopls) for the routing.
|
||||||
|
External communication occurs via the **REST API and web sockets**; internal communication happens via gRPC.
|
||||||
|
|
||||||
|
Non-binary data is handled by the store layer and stored inside a database; currently **MySQL and PostgreSQL**.
|
||||||
|
We will add support for additional databases in the future.
|
||||||
|
Binary data is handled locally or on a supported cloud provider using [MinIO](https://min.io/).
|
||||||
|
|
||||||
|
<br />
|
||||||
|
|
||||||
|
## What is Corteza?
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<img style="max-height: 350px;" src=".github/assets/corteza_dashboard.png" />
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Corteza is the only **100% free**, **open-source**, **standardized** and **enterprise-grade** Low-code platform.
|
||||||
|
It is developed entirely in the public domain and maintained by [Crust Technology](https://www.crust.tech/), its founder.
|
||||||
|
|
||||||
|
With Corteza, you can quickly **build scalable cloud applications** that are **integrable** with external services and **accessible (WCAG 2.1)**.
|
||||||
|
|
||||||
|
### Core features:
|
||||||
|
|
||||||
|
* quick setup,
|
||||||
|
* flexible and intuitive low-code configuration,
|
||||||
|
* powerful automation system using workflows and automation scripts,
|
||||||
|
* flexible reporting capabilities,
|
||||||
|
* secure RBAC access control system.
|
||||||
|
|
||||||
|
## Online demo
|
||||||
|
|
||||||
|
You can check out Corteza online by creating an account on our community instance https://latest.cortezaproject.org.
|
||||||
|
|
||||||
|
## Deploying Corteza
|
||||||
|
|
||||||
|
Refer to the [DevOps guide](https://docs.cortezaproject.org/corteza-docs/2022.3/devops-guide/index.html) for a complete guide on how to get Corteza up and running.
|
||||||
|
Additionally, we've provided some [video instructions](https://forum.cortezaproject.org/t/videos-on-how-to-set-up-corteza/91).
|
||||||
|
|
||||||
|
Quick references:
|
||||||
|
|
||||||
|
* [data backup and restore](https://docs.cortezaproject.org/corteza-docs/2022.3/devops-guide/maintenance/backups.html)
|
||||||
|
* [troubleshooting](https://docs.cortezaproject.org/corteza-docs/2022.3/devops-guide/troubleshooting/index.html)
|
||||||
|
* [setting up an email relay](https://docs.cortezaproject.org/corteza-docs/2022.3/devops-guide/email-relay.html)
|
||||||
|
* [setting up sink routes](https://docs.cortezaproject.org/corteza-docs/2022.3/devops-guide/sink-route.html)
|
||||||
|
|
||||||
|
## Upgrading Corteza
|
||||||
|
|
||||||
|
[](https://img.shields.io/github/v/tag/cortezaproject/corteza?label=latest%20stable%20version)
|
||||||
|
|
||||||
|
Refer to the [changelog](https://docs.cortezaproject.org/corteza-docs/2022.3/changelog/index.html) and the [upgrade guide](https://docs.cortezaproject.org/corteza-docs/2022.3/devops-guide/upgrade/index.html) to upgrade your Corteza instance.
|
||||||
|
|
||||||
|
## Using Corteza
|
||||||
|
|
||||||
|
Refer to the [End-User Guide](https://docs.cortezaproject.org/corteza-docs/2022.3/end-user-guide/index.html) to learn the built-in applications and features from the end-user perspective.
|
||||||
|
|
||||||
|
Quick references:
|
||||||
|
|
||||||
|
* [Corteza CRM](https://docs.cortezaproject.org/corteza-docs/2022.3/end-user-guide/crm/index.html)
|
||||||
|
* [Corteza Case Management](https://docs.cortezaproject.org/corteza-docs/2022.3/end-user-guide/case-management/index.html)
|
||||||
|
|
||||||
|
## Create with Corteza
|
||||||
|
|
||||||
|
Refer to the [Integrator Guide](https://docs.cortezaproject.org/corteza-docs/2022.3/integrator-guide/index.html) to learn how you can build on the core features to create virtually anything.
|
||||||
|
|
||||||
|
Quick references:
|
||||||
|
|
||||||
|
* [Corteza Compose configuration](https://docs.cortezaproject.org/corteza-docs/2022.3/integrator-guide/compose-configuration/index.html)
|
||||||
|
* automation using [workflows](https://docs.cortezaproject.org/corteza-docs/2022.3/integrator-guide/automation/workflows/index.html) and [automation scripts](https://docs.cortezaproject.org/corteza-docs/2022.3/integrator-guide/automation/automation-scripts/index.html)
|
||||||
|
* [using the REST API](https://docs.cortezaproject.org/corteza-docs/2022.3/integrator-guide/accessing-corteza/index.html),
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Refer to the [Developer Guide/Corteza Server](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/corteza-server/index.html) document for details regarding the [development setup](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/corteza-server/index.html#_development_setup), the [project structure](https://docs.cortezaproject.org/corteza-docs/2022.3/developer-guide/corteza-server/structure.html), and the feature insight documents.
|
||||||
|
|
||||||
|
Refer to the [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines and code of conduct.
|
||||||
|
|
||||||
|
Quick command reference:
|
||||||
|
|
||||||
|
* run server: `make watch`
|
||||||
|
* run unit tests: `make test.unit`
|
||||||
|
* run integration tests: `make test.integration`
|
||||||
|
* run all tests `make test.all`
|
||||||
|
* run MailHog (local SMTP server): `make mailhog.up` (requires Docker)
|
||||||
|
|
||||||
|
## Community
|
||||||
|
|
||||||
|
Reach out to us on [our forum](https://forum.cortezaproject.org/).
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Corteza is released under the Apache-2.0 license.
|
||||||
|
Refer to the [LICENSE](LICENSE) file for additional information.
|
||||||
37
SECURITY.md
Normal file
37
SECURITY.md
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
# Security
|
||||||
|
|
||||||
|
At Corteza, the security of our products and services is important to us.
|
||||||
|
All of our source code repositories are managed through GitHub organisations.
|
||||||
|
Here is the list of [Corteza Repositories](https://github.com/orgs/cortezaproject/repositories)
|
||||||
|
|
||||||
|
If you believe you have found a security vulnerability in any Corteza repository, please report it to us as described below.
|
||||||
|
|
||||||
|
## Reporting Security Issues
|
||||||
|
|
||||||
|
**Please do not report security vulnerabilities through public GitHub issues.**
|
||||||
|
|
||||||
|
Instead, please send email to [info@cortezaproject.org](mailto:info@cortezaproject.org).
|
||||||
|
|
||||||
|
You should receive a response within 24 business hours. If for some reason you do not,
|
||||||
|
please follow up via email to ensure we received your original message.
|
||||||
|
|
||||||
|
Please include the requested information listed below (as much as you can provide)
|
||||||
|
to help us better understand the nature and scope of the possible issue:
|
||||||
|
|
||||||
|
* Type of issue,
|
||||||
|
* full paths of source file(s) related to the manifestation of the issue,
|
||||||
|
* the location of the affected source code (tag/branch/commit or direct URL),
|
||||||
|
* any special configuration required to reproduce the issue,
|
||||||
|
* step-by-step instructions to reproduce the issue,
|
||||||
|
* proof-of-concept or exploit code (if possible),
|
||||||
|
* impact of the issue, including how an attacker might exploit the issue.
|
||||||
|
|
||||||
|
This information will help us triage your report more quickly.
|
||||||
|
|
||||||
|
## Preferred Languages
|
||||||
|
|
||||||
|
We prefer all communications to be in English.
|
||||||
|
|
||||||
|
## Policy
|
||||||
|
|
||||||
|
[Corteza Privacy Policy](https://cortezaproject.org/privacy-policy/)
|
||||||
Loading…
x
Reference in New Issue
Block a user