Dockerized application, added readme and logotype

This commit is contained in:
Dmitriy Shishkov 2021-10-17 20:51:47 +03:00
parent 48589d80f9
commit e3d1b989fb
No known key found for this signature in database
GPG Key ID: 14358F96FCDD8060
4 changed files with 128 additions and 5 deletions

4
.dockerignore Normal file
View File

@ -0,0 +1,4 @@
node_modules/
package-lock.json
pnpm-lock.yaml
dist/

14
Dockerfile Normal file
View File

@ -0,0 +1,14 @@
FROM node:alpine AS builder
WORKDIR /app
COPY ./package.json ./
RUN npm install
COPY ./ ./
RUN NODE_ENV=production npm run build
FROM node:alpine
RUN npm install serve -g --silent
WORKDIR /app
COPY --from=builder /app/dist .
EXPOSE 80
CMD ["serve", "-p", "80", "-s", "."]

View File

@ -1,17 +1,44 @@
# \<Project name\>
# Simple TODO application
<p align="center">
<img src="https://github.com/<Organization name>/<Repo name>/raw/main/logo.svg" alt="<Logo description>" width="150px">
<img src="https://github.com/dm1sh/toodo/raw/main/logo.svg" alt="TooDo logo" width="150px">
</p>
## Overview
\<Example text\>
TooDo is a simple application for tasks management. It was built for my own usage because I didn't like the look or functionality of other todo apps.
## Deploy
\<Deployment instruction\>
Server side of application is not ready yet, so, you can deploy it as a single docker image
```bash
<Code>
docker pull dm1sh/toodo:latest
docker run -p <port>:80 dm1sh/toodo:latest
```
To run it on baremetal:
```bash
git clone https://github.com/dm1sh/toodo
cd toodo
npm i
npm run build
npm run start
```
And finally, for development actions are quite similar to baremetal deploy:
```bash
git clone https://github.com/dm1sh/toodo
cd toodo
npm i
npm run dev
```
## TODO
- Add task saving on Enter key press, remapping new line to Shift+Enter
- Convert to monorepo and add backend for tasks syncing
- Add ServiceWorker
- Switch to IndexedDB

78
logo.svg Normal file
View File

@ -0,0 +1,78 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
width="512"
height="351"
viewBox="0 0 135.46666 92.868752"
version="1.1"
id="svg5"
inkscape:version="1.1 (c68e22c387, 2021-05-23)"
sodipodi:docname="logo.svg"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns="http://www.w3.org/2000/svg"
xmlns:svg="http://www.w3.org/2000/svg">
<sodipodi:namedview
id="namedview7"
pagecolor="#ffffff"
bordercolor="#999999"
borderopacity="1"
inkscape:pageshadow="0"
inkscape:pageopacity="0"
inkscape:pagecheckerboard="0"
inkscape:document-units="px"
showgrid="false"
units="px"
width="512px"
inkscape:zoom="1"
inkscape:cx="220"
inkscape:cy="243"
inkscape:window-width="1920"
inkscape:window-height="1000"
inkscape:window-x="-11"
inkscape:window-y="-11"
inkscape:window-maximized="1"
inkscape:current-layer="layer1"
showguides="true" />
<defs
id="defs2" />
<g
inkscape:label="Layer 1"
inkscape:groupmode="layer"
id="layer1">
<rect
style="fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:8.16147;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:0;stroke-dasharray:none;stroke-opacity:1;paint-order:normal"
id="rect3999"
width="135.46666"
height="92.868752"
x="0"
y="0" />
<g
id="g3915"
transform="matrix(0.85307089,0,0,0.85307089,9.9516264,-10.123503)">
<path
id="rect846"
style="color:#000000;fill:#000000;stroke-width:9.99999;-inkscape-stroke:none"
d="M -8.9238281,80 V 95 H 83.576172 v 320 h 15 V 95 H 191.07617 V 80 Z"
transform="scale(0.26458333)" />
<path
style="color:#000000;fill:#000000;stroke-miterlimit:0;-inkscape-stroke:none"
d="m 49.232422,29.103516 c -10.570572,0 -19.181641,8.613021 -19.181641,19.183593 0,10.570572 8.611069,19.181641 19.181641,19.181641 10.570572,0 19.183594,-8.611069 19.183594,-19.181641 0,-10.570572 -8.613022,-19.183593 -19.183594,-19.183593 z m 0,3.96875 c 8.425702,0 15.214844,6.789141 15.214844,15.214843 0,8.425703 -6.789142,15.212891 -15.214844,15.212891 -8.425703,0 -15.212891,-6.787188 -15.212891,-15.212891 0,-8.425702 6.787188,-15.214843 15.212891,-15.214843 z"
id="path1247" />
<path
style="color:#000000;fill:#000000;stroke-miterlimit:0;-inkscape-stroke:none"
d="m 49.232422,71.4375 c -10.570572,0 -19.181641,8.611069 -19.181641,19.181641 -3e-6,10.570569 8.611067,19.183589 19.181641,19.183589 10.570574,0 19.183597,-8.61302 19.183594,-19.183589 0,-10.570572 -8.613022,-19.181641 -19.183594,-19.181641 z m 0,3.96875 c 8.425702,0 15.214844,6.787188 15.214844,15.212891 2e-6,8.425704 -6.78914,15.214839 -15.214844,15.214839 -8.425704,0 -15.212893,-6.789135 -15.212891,-15.214839 0,-8.425703 6.787188,-15.212891 15.212891,-15.212891 z"
id="path1247-9" />
<path
id="path1247-8"
style="color:#000000;fill:#000000;stroke-width:3.77953;stroke-miterlimit:0;-inkscape-stroke:none"
d="M 288.42578,109.99805 V 110 h -14.84961 v 305 h 14.84961 v 0.002 c 0.0503,0 0.10014,-0.002 0.15039,-0.002 39.38092,-0.0808 71.52329,-31.78799 72.32617,-71 h 0.0215 V 182 h -0.008 c -0.27164,-39.72162 -32.7061,-72.00195 -72.49006,-72.00195 z M 288.57617,125 c 31.77532,0.0808 57.34571,25.70706 57.34571,57.50195 h 0.002 v 159.9961 h -0.002 c 0,31.79489 -25.57039,57.4211 -57.34571,57.50195 z"
transform="scale(0.26458333)" />
<path
style="color:#000000;fill:#000000;stroke-miterlimit:0;-inkscape-stroke:none"
d="m 118.64453,73.068359 c -10.57057,-2e-6 -19.181639,8.611067 -19.181639,19.181641 -3e-6,10.57058 8.611069,19.18164 19.181639,19.18164 10.57058,0 19.1836,-8.61106 19.18359,-19.18164 10e-6,-10.570574 -8.61302,-19.181643 -19.18359,-19.181641 z m 0,3.96875 c 8.42571,-2e-6 15.21485,6.787187 15.21484,15.212891 10e-6,8.42571 -6.78913,15.21289 -15.21484,15.21289 -8.4257,0 -15.21289,-6.78718 -15.21289,-15.21289 0,-8.425704 6.78719,-15.212893 15.21289,-15.212891 z"
id="path1247-3" />
</g>
</g>
</svg>

After

Width:  |  Height:  |  Size: 4.2 KiB