Skip to content

Commit 5bb26cc

Browse files
committed
Initial commit
Signed-off-by: mikesir87 <[email protected]> Imported from dockersamples/101-tutorial, removed other languages for now, and replaced PWD references with Docker Desktop.
0 parents  commit 5bb26cc

File tree

79 files changed

+34476
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+34476
-0
lines changed

.dockerignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
node_modules

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
node_modules

Dockerfile

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Install the base requirements for the app.
2+
# This stage is to support development.
3+
FROM python:alpine AS base
4+
WORKDIR /app
5+
COPY requirements.txt .
6+
RUN pip install -r requirements.txt
7+
8+
# Run tests to validate app
9+
FROM node:12-alpine AS app-base
10+
WORKDIR /app
11+
COPY app/package.json app/yarn.lock ./
12+
RUN yarn install
13+
COPY app/spec ./spec
14+
COPY app/src ./src
15+
RUN yarn test
16+
17+
# Clear out the node_modules and create the zip
18+
FROM app-base AS app-zip-creator
19+
RUN rm -rf node_modules && \
20+
apk add zip && \
21+
zip -r /app.zip /app
22+
23+
# Dev-ready container - actual files will be mounted in
24+
FROM base AS dev
25+
CMD ["mkdocs", "serve", "-a", "0.0.0.0:8000"]
26+
27+
# Do the actual build of the mkdocs site
28+
FROM base AS build
29+
COPY . .
30+
ARG LANGUAGE
31+
RUN mkdocs build
32+
33+
# Extract the static content from the build
34+
# and use a nginx image to serve the content
35+
FROM nginx:alpine
36+
COPY --from=app-zip-creator /app.zip /usr/share/nginx/html/assets/app.zip
37+
COPY --from=build /app/site /usr/share/nginx/html

LICENSE

+201
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 {yyyy} {name of copyright owner}
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.

README.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Docker Getting Started Tutorial
2+
3+
This tutorial has been written with the intent of helping folks get up and running
4+
with containers and is designed to work with Docker Desktop. While not going too much
5+
into depth, it covers the following topics:
6+
7+
- Running your first container
8+
- Building containers
9+
- Learning what containers are running and removing them
10+
- Using volumes to persist data
11+
- Using bind mounts to support development
12+
- Using container networking to support multi-container applications
13+
- Using Docker Compose to simplify the definition and sharing of applications
14+
- Using image layer caching to speed up builds and reduce push/pull size
15+
- Using multi-stage builds to separate build-time and runtime dependencies
16+
17+
## Getting Started
18+
19+
If you wish to run the tutorial, you can use the following command after installing Docker Desktop:
20+
21+
```bash
22+
docker run -dp 80:80 docker/getting-started
23+
```
24+
25+
Once it has started, you can open your browser to [http://localhost](http://localhost).
26+
27+
28+
## Development
29+
30+
This project has a `docker-compose.yml` file, which will start the mkdocs application on your
31+
local machine and help you see changes instantly.
32+
33+
```bash
34+
docker-compose up
35+
```
36+
37+
38+
## Contributing
39+
40+
If you find typos or other issues with the tutorial, feel free to create a PR and suggest fixes!
41+
42+
If you have ideas on how to make the tutorial better or new content, please open an issue first
43+
before working on your idea. While we love input, we want to keep the tutorial is scoped to new-comers.
44+
As such, we may reject ideas for more advanced requests and don't want you to lose any work you might
45+
have done. So, ask first and we'll gladly hear your thoughts!
46+

app/package.json

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"name": "101-app",
3+
"version": "1.0.0",
4+
"main": "index.js",
5+
"license": "MIT",
6+
"scripts": {
7+
"prettify": "prettier -l --write \"**/*.js\"",
8+
"test": "jest",
9+
"dev": "nodemon src/index.js"
10+
},
11+
"dependencies": {
12+
"body-parser": "^1.19.0",
13+
"express": "^4.17.1",
14+
"mysql": "^2.17.1",
15+
"sqlite3": "^4.1.0",
16+
"uuid": "^3.3.3",
17+
"wait-port": "^0.2.2"
18+
},
19+
"prettier": {
20+
"trailingComma": "all",
21+
"tabWidth": 4,
22+
"useTabs": false,
23+
"semi": true,
24+
"singleQuote": true
25+
},
26+
"devDependencies": {
27+
"jest": "^24.9.0",
28+
"nodemon": "^1.19.2",
29+
"prettier": "^1.18.2"
30+
}
31+
}

app/spec/persistence/sqlite.spec.js

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
const db = require('../../src/persistence/sqlite');
2+
const fs = require('fs');
3+
4+
const ITEM = {
5+
id: '7aef3d7c-d301-4846-8358-2a91ec9d6be3',
6+
name: 'Test',
7+
completed: false,
8+
};
9+
10+
beforeEach(() => {
11+
if (fs.existsSync('/etc/todos/todo.db')) {
12+
fs.unlinkSync('/etc/todos/todo.db');
13+
}
14+
});
15+
16+
test('it initializes correctly', async () => {
17+
await db.init();
18+
});
19+
20+
test('it can store and retrieve items', async () => {
21+
await db.init();
22+
23+
await db.storeItem(ITEM);
24+
25+
const items = await db.getItems();
26+
expect(items.length).toBe(1);
27+
expect(items[0]).toEqual(ITEM);
28+
});
29+
30+
test('it can update an existing item', async () => {
31+
await db.init();
32+
33+
const initialItems = await db.getItems();
34+
expect(initialItems.length).toBe(0);
35+
36+
await db.storeItem(ITEM);
37+
38+
await db.updateItem(
39+
ITEM.id,
40+
Object.assign({}, ITEM, { completed: !ITEM.completed }),
41+
);
42+
43+
const items = await db.getItems();
44+
expect(items.length).toBe(1);
45+
expect(items[0].completed).toBe(!ITEM.completed);
46+
});
47+
48+
test('it can remove an existing item', async () => {
49+
await db.init();
50+
await db.storeItem(ITEM);
51+
52+
await db.removeItem(ITEM.id);
53+
54+
const items = await db.getItems();
55+
expect(items.length).toBe(0);
56+
});
57+
58+
test('it can get a single item', async () => {
59+
await db.init();
60+
await db.storeItem(ITEM);
61+
62+
const item = await db.getItem(ITEM.id);
63+
expect(item).toEqual(ITEM);
64+
});

0 commit comments

Comments
 (0)