Skip to content

Commit 0375933

Browse files
committed
chore: add project scaffolding with CI, docs, and deployment config
1 parent b484ed5 commit 0375933

File tree

5 files changed

+421
-66
lines changed

5 files changed

+421
-66
lines changed

.github/workflows/ci.yml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
strategy:
13+
matrix:
14+
node-version: [20, 22]
15+
16+
steps:
17+
- name: Checkout
18+
uses: actions/checkout@v4
19+
20+
- name: Setup Node.js
21+
uses: actions/setup-node@v4
22+
with:
23+
node-version: ${{ matrix.node-version }}
24+
cache: 'npm'
25+
26+
- name: Install dependencies
27+
run: npm ci
28+
29+
- name: Type check
30+
run: npx tsc --noEmit
31+
32+
- name: Build
33+
run: npm run build
34+
35+
scaffold-smoke-test:
36+
runs-on: ubuntu-latest
37+
steps:
38+
- name: Checkout
39+
uses: actions/checkout@v4
40+
41+
- name: Setup Node.js
42+
uses: actions/setup-node@v4
43+
with:
44+
node-version: 20
45+
cache: 'npm'
46+
47+
- name: Test degit scaffold
48+
run: |
49+
cd /tmp
50+
npx degit ${{ github.repository }} test-scaffold
51+
cd test-scaffold
52+
npm ci
53+
npm run build

LICENSE

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

0 commit comments

Comments
 (0)