Merge pull request #22 from fullstack-development/update-kit

Update kit

Author: hersveit

.gitignore

@@ -1,32 +1,3 @@
-# compiled output
-dist
-node_modules
-env/dev.env
-env/prod.env
+node_modules/
 
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-
-# OS
-.DS_Store
-
-# Tests
-coverage
-.nyc_output
-
-# IDEs and editors
-.idea
-.project
-.classpath
-.c9/
-*.launch
-.settings/
-*.sublime-workspace
-
-# IDE - VSCode
-.vscode/*
+.vscode

Dockerfile Dockerfile.apiDockerfile renamed to Dockerfile.api

@@ -1,13 +1,16 @@
 FROM node:14-alpine as deps
 RUN apk add --no-cache libc6-compat
 WORKDIR /app
-COPY yarn.lock package.json ./
-RUN yarn install --frozen-lockfile --silent
+COPY ./api/yarn.lock ./api/package.json ./
+COPY ./schema.prisma ./src/schema.prisma
+RUN yarn install --ignore-scripts --frozen-lockfile --silent
+RUN npx prisma generate --schema="./src/schema.prisma"
 
 FROM node:14-alpine as builder
 WORKDIR /app
 COPY --from=deps /app/node_modules ./node_modules
-COPY . .
+COPY ./api .
+COPY ./schema.prisma ./src/schema.prisma
 RUN yarn build
 
 FROM node:14-alpine as runner
@@ -17,6 +20,7 @@ RUN adduser -S nestjs -u 1001
 
 COPY --from=builder --chown=nestjs:nodejs /app/dist ./dist
 COPY --from=builder --chown=nestjs:nodejs /app/node_modules ./node_modules
+COPY --from=builder --chown=nestjs:nodejs /app/src/swagger.yaml ./src/swagger.yaml
 
 ENV DB_ADDRESS=$DB_ADDRESS
 ENV DB_USER=$DB_USER
@@ -28,9 +32,10 @@ ENV JWT_EXPIRES_IN=$JWT_EXPIRES_IN
 ENV PORT_API=$PORT_API 
 ENV JWT_REFRESH_TOKEN_SECRET=$JWT_REFRESH_TOKEN_SECRET 
 ENV JWT_REFRESH_TOKEN_EXPIRATION_TIME=$JWT_REFRESH_TOKEN_EXPIRATION_TIME
+ENV ENVIRONMENT=$ENVIRONMENT
 
 USER nestjs
 
 EXPOSE 3000
 
-CMD ["sh", "-c", "DB_ADDRESS=$DB_ADDRESS DB_USER=$DB_USER DB_PASSWORD=$DB_PASSWORD DB_NAME=$DB_NAME DB_PORT=$DB_PORT JWT_SECRET=$JWT_SECRET JWT_EXPIRES_IN=$JWT_EXPIRES_IN PORT_API=$PORT_API JWT_REFRESH_TOKEN_SECRET=$JWT_REFRESH_TOKEN_SECRET JWT_REFRESH_TOKEN_EXPIRATION_TIME=$JWT_REFRESH_TOKEN_EXPIRATION_TIME NODE_ENV=production node dist/main"]
+CMD ["sh", "-c", "ENVIRONMENT=$ENVIRONMENT DB_ADDRESS=$DB_ADDRESS DB_USER=$DB_USER DB_PASSWORD=$DB_PASSWORD DB_NAME=$DB_NAME DB_PORT=$DB_PORT JWT_SECRET=$JWT_SECRET JWT_EXPIRES_IN=$JWT_EXPIRES_IN PORT_API=$PORT_API JWT_REFRESH_TOKEN_SECRET=$JWT_REFRESH_TOKEN_SECRET JWT_REFRESH_TOKEN_EXPIRATION_TIME=$JWT_REFRESH_TOKEN_EXPIRATION_TIME NODE_ENV=production node dist/src/main"]

README.md

@@ -1,2 +1,55 @@
-# nestjs-starter-kit
-starter kit for node js
+# Starter kit Node js
+
+## Links
+
+1. [API doc](./api/Readme.md)
+
+## Preparations
+### Installation
+
+Do installations step by step:
+
+1.  Install dependencies for `api`
+
+    ```bash
+    cd ./api
+    yarn
+    ```
+
+    The postinstall script will generate prisma types for you
+
+    `On windows can be not work auto generating prisma schema. You can manual copy schema.prisma in api/src/schema.prisma`
+
+2.  Then install dependencies for `e2e`
+
+    ```bash
+    cd ./e2e
+    yarn
+    ```
+
+    The postinstall script will generate prisma types for you
+
+    `On windows can be not work auto generating prisma schema. You can manual copy schema.prisma in e2e/src/schema.prisma`
+
+### Launch
+
+#### Local with docker
+
+1. Run docker containers via docker-compose from the root folder of the repository
+
+   ```bash
+   docker compose -f stk.docker-compose.yaml up -d --build
+   ```
+
+2. Go to `api/env` folder and create copy of `dev.example.env` to `dev.env`
+   ```bash
+   cd ./api/env
+   cp ./dev.example.env ./dev.env
+   ```
+3. Copy `schema.prisma` from root dir in `api/src/schema.prisma`
+4. Go up to `api` and launch migrations
+   ```bash
+   cd ../
+   source ./env/dev.env && DATABASE_URL=$DATABASE_URL yarn prisma:migrate:deploy
+   ```
+   - Press `Yes (y)` if it asks you to install missed dependencies

.dockerignore api/.dockerignore.dockerignore renamed to api/.dockerignore

@@ -3,7 +3,6 @@
 .git
 Dockerfile
 node_modules
-eslint-plugin/node_modules
 dist
 env
 coverage

.eslintignore api/.eslintignore.eslintignore renamed to api/.eslintignore

@@ -0,0 +1,36 @@
+# compiled output
+dist
+node_modules
+env/dev.env
+env/prod.env
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+coverage
+.nyc_output
+
+# IDEs and editors
+.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+
+src/schema.prisma
+env/dev.env
+env/dev.docker.env

.eslintrc.js api/.eslintrc.js.eslintrc.js renamed to api/.eslintrc.js

@@ -0,0 +1,20 @@
+module.exports = {
+    bracketSpacing: true,
+    jsxBracketSameLine: false,
+    printWidth: 100,
+    semi: true,
+    singleQuote: true,
+    tabWidth: 4,
+    trailingComma: 'all',
+    useTabs: false,
+    endOfLine: 'lf',
+    overrides: [
+        {
+            files: '*.json',
+            options: {
+                singleQuote: false,
+                trailingComma: 'none',
+            },
+        },
+    ],
+};

api/.gitignore

@@ -0,0 +1,27 @@
+FROM node:16.17-alpine3.15
+
+COPY . /stk
+WORKDIR /stk
+
+ENV DB_ADDRESS=$DB_ADDRESS
+ENV DB_USER=$DB_USER
+ENV DB_PASSWORD=$DB_PASSWORD
+ENV DB_NAME=$DB_NAME 
+ENV DB_PORT=$DB_PORT
+ENV JWT_SECRET=$JWT_SECRET
+ENV JWT_EXPIRES_IN=$JWT_EXPIRES_IN 
+ENV PORT_API=$PORT_API 
+ENV JWT_REFRESH_TOKEN_SECRET=$JWT_REFRESH_TOKEN_SECRET 
+ENV JWT_REFRESH_TOKEN_EXPIRATION_TIME=$JWT_REFRESH_TOKEN_EXPIRATION_TIME
+ENV AUTH_CODE_EXPIRES_IN_MINUTES=$AUTH_CODE_EXPIRES_IN_MINUTES
+ENV FULL_PRODUCTION_MODE=$FULL_PRODUCTION_MODE
+ENV BLOCKPASS_SECRET_KEY=$BLOCKPASS_SECRET_KEY
+ENV BLOCKPASS_CLIENT_ID=$BLOCKPASS_CLIENT_ID
+ENV WORKER_HOST=$WORKER_HOST
+
+RUN yarn
+RUN yarn build
+
+EXPOSE 3000
+
+CMD ["sh", "-c", "sleep 2 && DATABASE_URL=postgres://${DB_USER}:${DB_PASSWORD}@${DB_ADDRESS}:5432/${DB_NAME} yarn prisma:migrate:dev && WORKER_HOST=$WORKER_HOST BLOCKPASS_CLIENT_ID=$BLOCKPASS_CLIENT_ID BLOCKPASS_SECRET_KEY=$BLOCKPASS_SECRET_KEY FULL_PRODUCTION_MODE=$FULL_PRODUCTION_MODE AUTH_CODE_EXPIRES_IN_MINUTES=$AUTH_CODE_EXPIRES_IN_MINUTES DB_ADDRESS=$DB_ADDRESS DB_USER=$DB_USER DB_PASSWORD=$DB_PASSWORD DB_NAME=$DB_NAME DB_PORT=$DB_PORT JWT_SECRET=$JWT_SECRET JWT_EXPIRES_IN=$JWT_EXPIRES_IN PORT_API=$PORT_API JWT_REFRESH_TOKEN_SECRET=$JWT_REFRESH_TOKEN_SECRET JWT_REFRESH_TOKEN_EXPIRATION_TIME=$JWT_REFRESH_TOKEN_EXPIRATION_TIME yarn start:prod"]