Skip to content

Commit 17a7352

Browse files
feat: oss files (#620)
* feat: oss files * fix: license typo * Rename makefile to Makefile * fix: malefile escape characters * Reduced Makefile commands * Small text adjustment in Makefile * Update LICENSE.md --------- Co-authored-by: svcAPLBot <174728082+svcAPLBot@users.noreply.github.com>
1 parent 03a127d commit 17a7352

File tree

5 files changed

+370
-0
lines changed

5 files changed

+370
-0
lines changed

AUTHORS.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# This file lists the authors and significant
2+
3+
# contributors to this project. This list may be
4+
5+
# incomplete; please refer to the code revision
6+
7+
# history to see individual contributions.
8+
9+
# Keep this list sorted alphabetically by last name.
10+
11+
Akamai Technologies, Inc.
12+
13+
## Core Maintainers
14+
15+
Ferruh Cihanoglu <fcihanog@akamai.com>
16+
Dennis van Kekem <dvankeke@akamai.com>
17+
18+
## Contributors
19+
20+
Ani Argjiri <aargjiri@akamai.com>
21+
Matthew Elderhorst <melderho@akamai.com>
22+
Matthias Erll <merll@akamai.com>
23+
Cas Lubbers <clubbers@akamai.com>
24+
Sander Rodenhuis <srodenhu@akamai.com>
25+
Jehoszafat Zimnowoda <jzimnowo@akamai.com>

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
We are happy to see that you are looking to help us
2+
improve apl-console! In order to ensure this goes as
3+
easy and quickly as possible, please follow the
4+
guidelines below:
5+
6+
## Reporting an Issue
7+
8+
Please report issues via GitHub.
9+
10+
Prior to opening a new issue, please check whether the
11+
same or a similar issue has already been opened.
12+
13+
## Contributing
14+
15+
If you have code or documentation changes, please
16+
don't hesitate to submit them using GitHub Pull
17+
Requests.
18+
19+
If your change is significant in size or fundamental
20+
in behavior, please make sure that prior to the PR
21+
there has been a public discussion on one of the
22+
project's mailing lists, ideally with some consensus
23+
having been reached.
24+
25+
Before submitting a PR for code changes, please make
26+
sure that it succeeds in running all tests.
27+
28+
If you have minor cosmetic changes, typos, grammatical
29+
improvements etc., no tests are needed.
30+
31+
## Coding Style
32+
33+
Please ensure that your code changes or additions
34+
match the current coding style used by the project.
35+
36+
## License
37+
38+
By contributing, you agree that your contributions
39+
will be licensed under its Apache License, Version
40+
2.0.

LICENSE.md

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2025 Akamai Technologies, Inc.
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

Makefile

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# =============================================================================
2+
# PROJECT: otomi-console (React + TypeScript)
3+
# USAGE: make <target> [PM=npm]
4+
# =============================================================================
5+
6+
# —–– Configurable —––––––––––––––––––––––––––––––––––––––––––––––––––––––––––
7+
PM ?= npm
8+
RUN = $(PM) run
9+
10+
# —–– Phony targets —––––––––––––––––––––––––––––––––––––––––––––––––––––––––
11+
.PHONY: help install dev docker start start\:chrome test lint lint-fix \
12+
format format-fix build eject prepare commit commit-retry \
13+
lint-staged gen-store spellcheck release release-minor \
14+
typecheck watch-ts run-if-changed lang-server lang-export \
15+
lang-import clean
16+
17+
# —–– Help —–––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––
18+
help: ## Show this help message
19+
@grep -E '^[a-zA-Z0-9_:-]+:.*?##' Makefile \
20+
| awk 'BEGIN {print "\nUsage:"} {split($$0,a,":"); printf " make %-15s %s\n", a[1], a[2]}' \
21+
| sed 's/## //g'
22+
23+
# —–– Install dependencies –––––––––––––––––––––––––––––––––––––––––––––––––––
24+
install: ## npm ci (clean install)
25+
$(PM) ci
26+
27+
# —–– Development —–––––––––––––––––––––––––––––––––––––––––––––––––––––––––––
28+
dev: ## npm run dev (parallel start/watch)
29+
$(RUN) dev
30+
31+
docker: ## npm run dev:docker (dockerized dev)
32+
$(RUN) dev:docker
33+
34+
start: ## npm start (CRA dev server)
35+
$(RUN) start
36+
37+
# —–– Testing & linting –––––––––––––––––––––––––––––––––––––––––––––––––––––
38+
test: ## npm run test (once)
39+
$(RUN) test
40+
41+
lint: ## npm run lint (includes typecheck)
42+
$(RUN) lint
43+
44+
# —–– Build –––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––
45+
build: ## npm run build (production bundle)
46+
$(RUN) build
47+
48+
# —–– Codegen & utils –––––––––––––––––––––––––––––––––––––––––––––––––––––––
49+
gen-store: ## npm run gen:store (RTK Query codegen)
50+
$(RUN) gen-store
51+
52+
# —–– Clean up —–––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––
53+
clean: ## remove node_modules & build artifacts
54+
rm -rf node_modules build

SECURITY.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Security Policies and Procedures
2+
3+
This document outlines security procedures and general
4+
policies for the apl-console repository.
5+
6+
Thanks for helping to secure the internet!
7+
8+
## Reporting Security Issues
9+
10+
_Note: Please do not report security vulnerabilities
11+
through public GitHub issues._
12+
13+
Instead, please report them through Akamai's [bug
14+
bounty
15+
program](https://hackerone.com/akamai?type=team) or
16+
reach out to
17+
[security@akamai.com](mailto:security@akamai.com).
18+
19+
If you wish to encrypt your communications, please use
20+
the [Akamai Security PGP
21+
key](https://www.akamai.com/content/dam/site/en/documents/akamai/2023/akamai-security-general.pub).
22+
23+
Please include the following information in your
24+
report:
25+
26+
- the type of issue (e.g., buffer overflow, SQL injection, cross-site scripting, ...)
27+
- full paths of source file(s) related to the manifestation of the issue
28+
- the location of the affected source code (tag/branch/commit or direct URL)
29+
- any special configuration required to reproduce the issue
30+
- step-by-step instructions to reproduce the issue
31+
- proof-of-concept or exploit code (if possible)
32+
- impact of the issue, including how an attacker might exploit the issue
33+
34+
We will work with you on resolving the issue and may
35+
then create a public GitHub issue to track the update
36+
and ensure transparency after we have resolved the
37+
vulnerability.
38+
39+
## Policy
40+
41+
The Akamai [Security Research
42+
Agreement](https://www.akamai.com/content/dam/site/en/documents/akamai/2024/security-research-agreement.pdf)
43+
(SRA) provides the general framework for how you are
44+
permitted to engage in any effort arising from or
45+
related to the security of the Akamai ecosystem. By
46+
participating in any of Akamai’s programs, you agree
47+
to be subject to the SRA.
48+
49+
For more information, please see the
50+
[Akamai Vulnerability Reporting](https://www.akamai.com/global-services/support/vulnerability-reporting) website.

0 commit comments

Comments
 (0)