Project structure init with the docker file + guides

Author: SurenNorekyanCodesignal

.gitignore

@@ -0,0 +1,56 @@
+# compiled output
+/dist
+/node_modules
+/build
+
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-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/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# temp directory
+.temp
+.tmp
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

Dockerfile

@@ -0,0 +1,34 @@
+# Multi-stage Dockerfile for NestJS app
+
+FROM node:20-alpine AS base
+WORKDIR /app
+
+# Install dependencies separately for layer caching
+FROM base AS deps
+COPY package.json package-lock.json ./
+RUN npm ci --no-audit --no-fund
+
+# Build the application (needs devDependencies like @nestjs/cli)
+FROM deps AS build
+COPY . .
+RUN npm run build
+
+# Prune dev dependencies to shrink runtime size
+RUN npm prune --omit=dev
+
+# Final runtime image
+FROM node:20-alpine AS runner
+ENV NODE_ENV=production
+ENV PORT=3000
+WORKDIR /app
+
+# Only copy what is needed at runtime
+COPY --from=build /app/node_modules ./node_modules
+COPY --from=build /app/package.json ./package.json
+COPY --from=build /app/package-lock.json ./package-lock.json
+COPY --from=build /app/dist ./dist
+COPY --from=build /app/public ./public
+
+EXPOSE 3000
+# Because tsconfig includes project root, compiled entry is dist/src/main.js
+CMD ["node", "dist/src/main.js"]

README.md

@@ -1,2 +1,98 @@
-# learn_reading-tracker-app
-NestJS Reading Tracker app backend
+<p align="center">
+  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
+</p>
+
+[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
+[circleci-url]: https://circleci.com/gh/nestjs/nest
+
+  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
+    <p align="center">
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
+<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
+<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
+<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
+<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
+  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a>
+    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
+  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow" alt="Follow us on Twitter"></a>
+</p>
+  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
+  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
+
+## Description
+
+[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
+
+## Project setup
+
+```bash
+$ npm install
+```
+
+## Compile and run the project
+
+```bash
+# development
+$ npm run start
+
+# watch mode
+$ npm run start:dev
+
+# production mode
+$ npm run start:prod
+```
+
+## Run tests
+
+```bash
+# unit tests
+$ npm run test
+
+# e2e tests
+$ npm run test:e2e
+
+# test coverage
+$ npm run test:cov
+```
+
+## Deployment
+
+When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information.
+
+If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:
+
+```bash
+$ npm install -g @nestjs/mau
+$ mau deploy
+```
+
+With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.
+
+## Resources
+
+Check out a few resources that may come in handy when working with NestJS:
+
+- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
+- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
+- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
+- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
+- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
+- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
+- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
+- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
+
+## Support
+
+Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
+
+## Stay in touch
+
+- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
+- Website - [https://nestjs.com](https://nestjs.com/)
+- Twitter - [@nestframework](https://twitter.com/nestframework)
+
+## License
+
+Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).

docker-guide-macos

@@ -0,0 +1,79 @@
+# Docker Guide (macOS + Docker Desktop)
+
+This guide walks you through building and running the NestJS app in Docker on macOS.
+
+## Prerequisites
+- Docker Desktop for macOS installed and running
+- Terminal opened at the project root (same folder as `Dockerfile`)
+
+## 1) Build the Docker image
+- Builds the production image using the multi‑stage `Dockerfile`.
+
+```
+docker build -t reading-tracker-app:latest .
+```
+
+## 2) Run the container (map port 3000)
+- Runs the container in detached mode and maps host port 3000 to container port 3000.
+
+```
+docker run -d --name reading-tracker -p 3000:3000 reading-tracker-app:latest
+```
+
+If your Mac already uses port 3000, map a different host port (for example, 8080):
+```
+docker run -d --name reading-tracker -p 8080:3000 reading-tracker-app:latest
+```
+
+## 3) Verify the app is running
+- Open the app in your browser:
+```
+open http://localhost:3000
+```
+- Or test the public API endpoint:
+```
+curl http://localhost:3000/api/hello
+```
+Expected response:
+```
+{"success":true,"data":"Hello World!"}
+```
+
+## 4) View logs (optional)
+- Stream container logs to troubleshoot or confirm startup:
+```
+docker logs -f reading-tracker
+```
+
+## 5) Stop and remove the container
+- Stop the running container:
+```
+docker stop reading-tracker
+```
+- Remove the stopped container:
+```
+docker rm reading-tracker
+```
+
+## 6) Rebuild and clean up tips
+- Rebuild without using cache:
+```
+docker build --no-cache -t reading-tracker-app:latest .
+```
+- Remove the image (forces a clean rebuild next time):
+```
+docker rmi reading-tracker-app:latest
+```
+- List running containers:
+```
+docker ps
+```
+- List all containers (including exited):
+```
+docker ps -a
+```
+
+## Notes
+- The container exposes port 3000 and starts via `node dist/src/main.js`.
+- Static assets are served from `/app/public` and API endpoints are under `/api`, `/users`, `/books`, `/reading`, `/auth`, `/admin`, `/friends`.
+

docker-guide-windows

@@ -0,0 +1,77 @@
+# Docker Guide (Windows + Docker Desktop)
+
+This guide walks you through building and running the NestJS app in Docker on Windows (PowerShell or Command Prompt).
+
+## Prerequisites
+- Docker Desktop for Windows installed and running
+- Terminal opened at the project root (same folder as `Dockerfile`)
+
+## 1) Build the Docker image
+Run in PowerShell or CMD:
+```
+docker build -t reading-tracker-app:latest .
+```
+
+## 2) Run the container (map port 3000)
+Detached mode, mapping host port 3000 to container port 3000:
+```
+docker run -d --name reading-tracker -p 3000:3000 reading-tracker-app:latest
+```
+
+If port 3000 is in use on Windows, map a different host port (e.g., 8080):
+```
+docker run -d --name reading-tracker -p 8080:3000 reading-tracker-app:latest
+```
+
+## 3) Verify the app is running
+- In a browser, open:
+```
+http://localhost:3000
+```
+- Or verify the public API endpoint. On Windows, prefer `curl.exe` to avoid PowerShell aliasing:
+```
+curl.exe http://localhost:3000/api/hello
+```
+Expected response:
+```
+{"success":true,"data":"Hello World!"}
+```
+
+## 4) View logs (optional)
+Tail container logs:
+```
+docker logs -f reading-tracker
+```
+
+## 5) Stop and remove the container
+Stop the container:
+```
+docker stop reading-tracker
+```
+Remove the stopped container:
+```
+docker rm reading-tracker
+```
+
+## 6) Rebuild and clean up tips
+Rebuild without cache:
+```
+docker build --no-cache -t reading-tracker-app:latest .
+```
+Remove the image (forces clean rebuild next time):
+```
+docker rmi reading-tracker-app:latest
+```
+List running containers:
+```
+docker ps
+```
+List all containers (including exited):
+```
+docker ps -a
+```
+
+## Notes
+- The container exposes port 3000 and starts via `node dist/src/main.js`.
+- Static assets are served from `/app/public` and API routes include `/api`, `/users`, `/books`, `/reading`, `/auth`, `/admin`, `/friends`.
+