Testman v2

.dockerignore

@@ -0,0 +1,13 @@
+node_modules
+npm-debug.log
+yarn-debug.log
+Dockerfile*
+docker-compose*
+.dockerignore
+.git
+.gitignore
+dist
+README.md
+LICENSE
+.DS_Store
+.env*

.gitignore

@@ -1,27 +1,20 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
 
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
+# testing
+/coverage
 
-# Coverage directory used by tools like istanbul
-coverage
+# production
+/dist
 
-node_modules/
-.npm
-.yarn-integrity
+# misc
+.DS_Store
+.env.*
 
-.data
-.db
-client/dist
-.env
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

Dockerfile.dev

@@ -0,0 +1,8 @@
+FROM node:alpine
+
+WORKDIR /usr/src/webapp
+
+COPY package.json .
+COPY yarn.lock .
+RUN yarn
+COPY . .

Dockerfile.prod

@@ -0,0 +1,15 @@
+FROM nginx
+
+RUN apt-get update
+RUN apt-get install -y nodejs curl
+RUN curl -o- -L https://yarnpkg.com/install.sh | bash
+
+RUN rm /etc/nginx/conf.d/default.conf
+COPY nginx.conf /etc/nginx/nginx.conf
+
+WORKDIR /usr/src/webapp
+COPY package.json .
+COPY yarn.lock .
+RUN ~/.yarn/bin/yarn
+COPY . .
+RUN ~/.yarn/bin/yarn build

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Subir
+Copyright (c) 2020 Subir Chowdhuri
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,7 +1,7 @@
 <h1>
   <img src="https://raw.githubusercontent.com/schowdhuri/testman/master/common/images/TestMan.png" alt="Logo" />
   TestMan
-  
+
   <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License MIT" />
   <img src="https://img.shields.io/badge/node-%3E=8.x-brightgreen.svg" alt="npm >= 8.x" />
 </h1>
@@ -10,24 +10,41 @@ Minimal test-case management tool
 
 ## Development
 
-Install deps:
-```
-npm install
-```
-Generate production bundles:
-```
-npm run build
-```
+1. Create the `.env.dev` file and add `MYSQL_ROOT_PASSWORD=<some password>`
 
-Start the server:
-```
-npm start
+2. Get the development environment up and running:
+
+```bash
+$ docker-compose -f docker-compose.dev.yml up --build
+$ docker-compose -f docker-compose.dev.yml exec db mysql -u root -p --execute="CREATE DATABASE testman;"
+$ docker-compose -f docker-compose.dev.yml exec webapp node_modules/.bin/ts-node -P tsconfig.server.json scripts/setup.ts
+$ docker-compose -f docker-compose.dev.yml restart
 ```
 
-Head to http://localhost:3200/
+Open `http://localhost:3000`
 
+### node_modules
+Every time there's a change in `package.json` or `yarn.lock`, add
+the `-V` or `--renew-anon-volumes` switch to docker-compose.
+
+From the [docker documentation](https://docs.docker.com/compose/reference/up/), this is used to:
+
+> Recreate anonymous volumes instead of retrieving data from the previous containers.
+
+## Deploy
+
+1. Create the `.env.prod` file and add `MYSQL_ROOT_PASSWORD=<some password>`
+
+2. Create the production docker image:
+
+```bash
+$ docker-compose -f docker-compose.prod.yml up --build
+$ docker-compose -f docker-compose.prod.yml exec db mysql -u root -p --execute="CREATE DATABASE testman;"
+$ docker-compose -f docker-compose.prod.yml exec webapp node_modules/.bin/ts-node -P tsconfig.server.json scripts/setup.ts
+$ docker-compose -f docker-compose.prod.yml restart
+```
 
-PS: TestMan works and is stable. Though, I never got around to completing the [Roadmap to v1.0](https://github.com/schowdhuri/testman/projects/1?fullscreen=true)
+The app is served on `http://localhost/`
 
 ## License
 MIT