Merge pull request 'improvement: fixed some package.json issues. readme files updated.' (#11) from improvement/infrastructure into master
Reviewed-on: http://178.131.50.201:3000/admin/dyolink/pulls/11
This commit was merged in pull request #11.
This commit is contained in:
@@ -16,6 +16,9 @@
|
|||||||
# DEPLOY_SECRETS_DIR folder containing database.staging.env + backend.staging.env
|
# DEPLOY_SECRETS_DIR folder containing database.staging.env + backend.staging.env
|
||||||
#
|
#
|
||||||
# Runner: self-hosted with Docker; Git Bash recommended on Windows (shell: bash).
|
# Runner: self-hosted with Docker; Git Bash recommended on Windows (shell: bash).
|
||||||
|
#
|
||||||
|
# We do NOT use gitea.com/actions/checkout — many restricted networks cannot reach gitea.com.
|
||||||
|
# Checkout is a plain `git clone` from the same Gitea host (github.server_url / gitea alias).
|
||||||
|
|
||||||
name: Registry — build, push, deploy
|
name: Registry — build, push, deploy
|
||||||
|
|
||||||
@@ -34,8 +37,23 @@ jobs:
|
|||||||
outputs:
|
outputs:
|
||||||
image_tag: ${{ steps.meta.outputs.image_tag }}
|
image_tag: ${{ steps.meta.outputs.image_tag }}
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout (clone from this Gitea — no gitea.com)
|
||||||
uses: https://gitea.com/actions/checkout@v4
|
run: |
|
||||||
|
set -e
|
||||||
|
SERVER="${{ github.server_url }}"
|
||||||
|
SERVER="${SERVER%/}"
|
||||||
|
REPO="${{ github.repository }}"
|
||||||
|
BRANCH="${{ github.ref_name }}"
|
||||||
|
TOKEN="${{ github.token }}"
|
||||||
|
ACTOR="${{ github.actor }}"
|
||||||
|
HP="${SERVER#http://}"
|
||||||
|
HP="${HP#https://}"
|
||||||
|
if [[ "$SERVER" == https://* ]]; then
|
||||||
|
CLONE_URL="https://${ACTOR}:${TOKEN}@${HP}/${REPO}.git"
|
||||||
|
else
|
||||||
|
CLONE_URL="http://${ACTOR}:${TOKEN}@${HP}/${REPO}.git"
|
||||||
|
fi
|
||||||
|
GIT_TERMINAL_PROMPT=0 git clone --depth 1 --branch "$BRANCH" "$CLONE_URL" .
|
||||||
|
|
||||||
- name: Image tag and registry prefix
|
- name: Image tag and registry prefix
|
||||||
id: meta
|
id: meta
|
||||||
@@ -77,12 +95,23 @@ jobs:
|
|||||||
needs: build-and-push
|
needs: build-and-push
|
||||||
runs-on: self-hosted
|
runs-on: self-hosted
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout infrastructure only
|
- name: Checkout (shallow clone from this Gitea — no gitea.com)
|
||||||
uses: https://gitea.com/actions/checkout@v4
|
run: |
|
||||||
with:
|
set -e
|
||||||
sparse-checkout: |
|
SERVER="${{ github.server_url }}"
|
||||||
infrastructure
|
SERVER="${SERVER%/}"
|
||||||
sparse-checkout-cone-mode: true
|
REPO="${{ github.repository }}"
|
||||||
|
BRANCH="${{ github.ref_name }}"
|
||||||
|
TOKEN="${{ github.token }}"
|
||||||
|
ACTOR="${{ github.actor }}"
|
||||||
|
HP="${SERVER#http://}"
|
||||||
|
HP="${HP#https://}"
|
||||||
|
if [[ "$SERVER" == https://* ]]; then
|
||||||
|
CLONE_URL="https://${ACTOR}:${TOKEN}@${HP}/${REPO}.git"
|
||||||
|
else
|
||||||
|
CLONE_URL="http://${ACTOR}:${TOKEN}@${HP}/${REPO}.git"
|
||||||
|
fi
|
||||||
|
GIT_TERMINAL_PROMPT=0 git clone --depth 1 --branch "$BRANCH" "$CLONE_URL" .
|
||||||
|
|
||||||
- name: Write deploy.registry.env and validate secrets path
|
- name: Write deploy.registry.env and validate secrets path
|
||||||
run: |
|
run: |
|
||||||
|
|||||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -5,7 +5,6 @@ node_modules/
|
|||||||
npm-debug.log*
|
npm-debug.log*
|
||||||
yarn-debug.log*
|
yarn-debug.log*
|
||||||
yarn-error.log*
|
yarn-error.log*
|
||||||
package-lock.json
|
|
||||||
yarn.lock
|
yarn.lock
|
||||||
|
|
||||||
# === Build outputs ===
|
# === Build outputs ===
|
||||||
|
|||||||
115
README.md
Normal file
115
README.md
Normal file
@@ -0,0 +1,115 @@
|
|||||||
|
# Dyolink
|
||||||
|
|
||||||
|
Monorepo: **NestJS** backend (`backend/`), **Next.js** frontend (`frontend/`), **Docker** stack under `infrastructure/`.
|
||||||
|
|
||||||
|
Local development: see **`backend/README.md`** and **`frontend/README.md`**.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Deploy on your own server (Docker + Gitea)
|
||||||
|
|
||||||
|
High level: **build container images → push to a registry → server pulls images and runs Compose**. Optionally **Gitea Actions** automates that on every merge to `main` / `master`.
|
||||||
|
|
||||||
|
### 1. One-time server preparation
|
||||||
|
|
||||||
|
1. Install **Docker** and **Docker Compose** on the server.
|
||||||
|
2. Run **Gitea** with the **container registry** enabled (same host/port you use for `docker login`, e.g. `178.131.50.201:3000`).
|
||||||
|
3. Copy the repo (or deploy only `infrastructure/` + secrets). You need at least:
|
||||||
|
|
||||||
|
- `infrastructure/docker-compose.registry.yml`
|
||||||
|
- `infrastructure/nginx/` configs referenced by that compose file
|
||||||
|
- `infrastructure/database/init.sql` if used by your Postgres service
|
||||||
|
|
||||||
|
4. **Secrets on the server** (never commit real values):
|
||||||
|
|
||||||
|
- Copy `infrastructure/database.staging.env.example` → **`database.staging.env`** (Postgres user/password/db).
|
||||||
|
- Copy `infrastructure/backend.staging.env.example` → **`backend.staging.env`** (e.g. `DATABASE_URL`, JWT, pointing at the compose Postgres service name).
|
||||||
|
- Put both files in one directory on the server, e.g. `/opt/dyolink/secrets/`.
|
||||||
|
|
||||||
|
5. **Registry login from the server** (same credentials you use for `docker push`):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker login <registry-host>:<port> -u <user>
|
||||||
|
```
|
||||||
|
|
||||||
|
For HTTP registries, Docker may require **`insecure-registries`** on the daemon.
|
||||||
|
|
||||||
|
### 2. Manual deploy (build images elsewhere, run on server)
|
||||||
|
|
||||||
|
On your **dev machine** (after successful local builds):
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
$REG = "<registry-host>:<port>"
|
||||||
|
$OWN = "<registry-owner>"
|
||||||
|
$TAG = "manual"
|
||||||
|
|
||||||
|
docker build -t "${REG}/${OWN}/dyolink-backend:${TAG}" -t "${REG}/${OWN}/dyolink-backend:latest" ./backend
|
||||||
|
|
||||||
|
docker build `
|
||||||
|
--build-arg NEXT_PUBLIC_API_URL="http://<your-public-ip>:<nginx-port>/api" `
|
||||||
|
--build-arg NEXT_PUBLIC_APP_URL="http://<your-public-ip>:<nginx-port>" `
|
||||||
|
--build-arg NEXT_PUBLIC_APP_NAME="Dyolink" `
|
||||||
|
-t "${REG}/${OWN}/dyolink-frontend:${TAG}" `
|
||||||
|
-t "${REG}/${OWN}/dyolink-frontend:latest" `
|
||||||
|
./frontend
|
||||||
|
|
||||||
|
docker push "${REG}/${OWN}/dyolink-backend:${TAG}"
|
||||||
|
docker push "${REG}/${OWN}/dyolink-backend:latest"
|
||||||
|
docker push "${REG}/${OWN}/dyolink-frontend:${TAG}"
|
||||||
|
docker push "${REG}/${OWN}/dyolink-frontend:latest"
|
||||||
|
```
|
||||||
|
|
||||||
|
On the **server**, from `infrastructure/`:
|
||||||
|
|
||||||
|
1. Create **`deploy.registry.env`** (see `infrastructure/deploy.registry.env.example`):
|
||||||
|
|
||||||
|
- `REGISTRY_PREFIX=<host>:<port>/<owner>` (no `http://`, no trailing slash)
|
||||||
|
- `IMAGE_TAG=latest` or the tag you pushed
|
||||||
|
- `STAGING_HTTP_PORT=<host port>` (e.g. `8088` — browser uses `http://<ip>:8088`)
|
||||||
|
|
||||||
|
2. Set **`DEPLOY_SECRETS_DIR`** to the absolute path of the folder containing `database.staging.env` and `backend.staging.env` (you can export it in the shell or add it to `deploy.registry.env` if your Compose setup expects it).
|
||||||
|
|
||||||
|
3. Pull and start:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker compose -f docker-compose.registry.yml --env-file deploy.registry.env pull backend frontend
|
||||||
|
docker compose -f docker-compose.registry.yml --env-file deploy.registry.env up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
The backend container runs **`prisma migrate deploy`** on startup (via entrypoint) when `NODE_ENV=production`, so schema updates apply after you deploy a new image that includes new migrations.
|
||||||
|
|
||||||
|
### 3. Automatic deploy (Gitea Actions)
|
||||||
|
|
||||||
|
Workflow file: **`.gitea/workflows/registry-build-deploy.yml`**.
|
||||||
|
|
||||||
|
**Requirements:**
|
||||||
|
|
||||||
|
- **Gitea Actions** enabled for the repository.
|
||||||
|
- A **self-hosted runner** (with Docker) registered to Gitea — the workflow uses `runs-on: self-hosted`.
|
||||||
|
- **Repository → Actions → Variables** (examples):
|
||||||
|
|
||||||
|
- `REGISTRY_HOST` — e.g. `178.131.50.201:3000`
|
||||||
|
- `REGISTRY_OWNER` — image namespace (same as Docker image path after the host), e.g. `admin`
|
||||||
|
- `PUBLIC_BASE_URL` — URL users open in the browser, e.g. `http://178.131.50.201:8088` (no trailing slash)
|
||||||
|
- `DEPLOY_SECRETS_DIR` — **absolute path on the runner machine** to the folder containing `database.staging.env` and `backend.staging.env`
|
||||||
|
- Optional: `STAGING_HTTP_PORT` (defaults to `8088`)
|
||||||
|
|
||||||
|
- **Repository → Actions → Secrets:**
|
||||||
|
|
||||||
|
- `REGISTRY_USERNAME`
|
||||||
|
- `REGISTRY_PASSWORD` — access token with package read/write (or equivalent)
|
||||||
|
|
||||||
|
**Trigger:** push to **`main`** or **`master`**, or run the workflow manually (**workflow_dispatch**).
|
||||||
|
|
||||||
|
The pipeline clones from your Gitea instance, builds and pushes backend/frontend images, then on the runner runs **`docker compose pull`** and **`up -d`** using `infrastructure/docker-compose.registry.yml`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Related paths
|
||||||
|
|
||||||
|
| Path | Role |
|
||||||
|
|------|------|
|
||||||
|
| `backend/Dockerfile` | API image |
|
||||||
|
| `frontend/Dockerfile` | Web image |
|
||||||
|
| `infrastructure/docker-compose.registry.yml` | Pull-only staging stack (registry images + nginx + postgres) |
|
||||||
|
| `infrastructure/deploy.registry.env.example` | Template for `deploy.registry.env` |
|
||||||
1
backend/.npmrc
Normal file
1
backend/.npmrc
Normal file
@@ -0,0 +1 @@
|
|||||||
|
legacy-peer-deps=true
|
||||||
@@ -1,18 +1,19 @@
|
|||||||
# ============================================
|
# ============================================
|
||||||
# STAGE 1: BUILDER STAGE
|
# STAGE 1: BUILDER STAGE
|
||||||
# ============================================
|
# ============================================
|
||||||
FROM node:18-alpine AS builder
|
FROM node:20-alpine AS builder
|
||||||
|
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|
||||||
COPY package*.json ./
|
COPY package*.json ./
|
||||||
|
COPY .npmrc ./
|
||||||
COPY prisma ./prisma/
|
COPY prisma ./prisma/
|
||||||
|
|
||||||
RUN npm ci
|
RUN npm ci
|
||||||
|
|
||||||
COPY . .
|
COPY . .
|
||||||
|
|
||||||
RUN npx prisma generate
|
RUN npm run prisma:generate
|
||||||
RUN npm run build
|
RUN npm run build
|
||||||
RUN npm prune --production
|
RUN npm prune --production
|
||||||
|
|
||||||
@@ -20,7 +21,7 @@ RUN npm prune --production
|
|||||||
# ============================================
|
# ============================================
|
||||||
# STAGE 2: PRODUCTION STAGE
|
# STAGE 2: PRODUCTION STAGE
|
||||||
# ============================================
|
# ============================================
|
||||||
FROM node:18-alpine
|
FROM node:20-alpine
|
||||||
|
|
||||||
RUN apk add --no-cache dumb-init
|
RUN apk add --no-cache dumb-init
|
||||||
|
|
||||||
@@ -29,14 +30,10 @@ WORKDIR /app
|
|||||||
RUN addgroup -g 1001 -S nodejs && \
|
RUN addgroup -g 1001 -S nodejs && \
|
||||||
adduser -S dyolink -u 1001
|
adduser -S dyolink -u 1001
|
||||||
|
|
||||||
|
# Prisma client comes from the builder (npm prune --production keeps @prisma/client).
|
||||||
COPY package*.json ./
|
COPY package*.json ./
|
||||||
COPY prisma ./prisma/
|
COPY prisma ./prisma/
|
||||||
|
|
||||||
RUN npm ci --only=production && \
|
|
||||||
npm cache clean --force
|
|
||||||
|
|
||||||
RUN npx prisma generate
|
|
||||||
|
|
||||||
COPY --from=builder /app/dist ./dist
|
COPY --from=builder /app/dist ./dist
|
||||||
COPY --from=builder /app/node_modules ./node_modules
|
COPY --from=builder /app/node_modules ./node_modules
|
||||||
|
|
||||||
|
|||||||
@@ -1,98 +1,88 @@
|
|||||||
<p align="center">
|
# Dyolink — Backend (NestJS)
|
||||||
<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
|
## Prerequisites
|
||||||
[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>
|
- **Node.js 20+** and **npm**
|
||||||
<p align="center">
|
- **PostgreSQL** reachable from your machine (local or remote)
|
||||||
<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>
|
|
||||||
<!--[](https://opencollective.com/nest#backer)
|
|
||||||
[](https://opencollective.com/nest#sponsor)-->
|
|
||||||
|
|
||||||
## Description
|
## First-time setup
|
||||||
|
|
||||||
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
|
1. **Clone the monorepo** and go to the backend app:
|
||||||
|
|
||||||
## Project setup
|
```bash
|
||||||
|
git clone <repository-url> dyolink
|
||||||
|
cd dyolink/backend
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **Install dependencies**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Environment**
|
||||||
|
|
||||||
|
Copy `.env.example` to `.env` and set at least:
|
||||||
|
|
||||||
|
- `DATABASE_URL` — PostgreSQL connection string for your dev database
|
||||||
|
- `JWT_SECRET` — strong secret for signing tokens
|
||||||
|
Do not commit `.env`.
|
||||||
|
|
||||||
|
4. **Database URL for local dev**
|
||||||
|
|
||||||
|
Point `DATABASE_URL` at a database you created in Postgres (create an empty DB first if needed).
|
||||||
|
|
||||||
|
5. **Generate Prisma Client**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run prisma:generate
|
||||||
|
```
|
||||||
|
|
||||||
|
6. **Apply migrations** (creates/updates tables to match `prisma/schema.prisma`)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run prisma:migrate
|
||||||
|
```
|
||||||
|
|
||||||
|
This runs `prisma migrate dev`. Use it during development when the schema changes.
|
||||||
|
|
||||||
|
7. **Seed** (optional — sample data / bootstrap)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run prisma:seed
|
||||||
|
```
|
||||||
|
|
||||||
|
## Run (development)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ npm install
|
npm run start:dev
|
||||||
```
|
```
|
||||||
|
|
||||||
## Compile and run the project
|
API listens on **`http://localhost:3000`** by default (`PORT` in `.env`).
|
||||||
|
|
||||||
|
If the frontend runs on another origin (e.g. `http://localhost:3001`), set `CORS_ORIGIN` in `.env` to that URL.
|
||||||
|
|
||||||
|
## After pulling latest `main`
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# development
|
git pull
|
||||||
$ npm run start
|
npm install
|
||||||
|
npm run prisma:generate
|
||||||
# watch mode
|
npm run prisma:migrate
|
||||||
$ npm run start:dev
|
|
||||||
|
|
||||||
# production mode
|
|
||||||
$ npm run start:prod
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Run tests
|
If teammates added migrations, step 4 applies them. Resolve migration conflicts locally before pushing.
|
||||||
|
|
||||||
```bash
|
## Useful commands
|
||||||
# unit tests
|
|
||||||
$ npm run test
|
|
||||||
|
|
||||||
# e2e tests
|
| Command | Purpose |
|
||||||
$ npm run test:e2e
|
|--------|---------|
|
||||||
|
| `npm run prisma:generate` | Regenerate client after `schema.prisma` changes |
|
||||||
|
| `npm run prisma:migrate` | Dev migrations (`migrate dev`) |
|
||||||
|
| `npm run prisma:deploy` | Production-style apply (`migrate deploy`) — e.g. CI/containers |
|
||||||
|
| `npm run build` | Compile Nest app |
|
||||||
|
| `npm run start:prod` | Run compiled app (`node dist/main`) |
|
||||||
|
|
||||||
# test coverage
|
## Docker
|
||||||
$ npm run test:cov
|
|
||||||
```
|
|
||||||
|
|
||||||
## Deployment
|
Image build is defined in **`Dockerfile`** at this folder. For full-stack deployment and CI, see the **repository root `README.md`**.
|
||||||
|
|
||||||
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).
|
|
||||||
|
|||||||
@@ -1,95 +0,0 @@
|
|||||||
|
|
||||||
# Dyolink Backend - Development Setup Guide
|
|
||||||
|
|
||||||
## 📋 Prerequisites
|
|
||||||
|
|
||||||
Before starting, ensure you have the following installed:
|
|
||||||
- **Node.js** (v18 or higher)
|
|
||||||
- **PostgreSQL** (v15 or higher) - We use v18, but any v15+ works
|
|
||||||
- **Git** (for cloning)
|
|
||||||
- **npm** or **yarn** (npm comes with Node.js)
|
|
||||||
|
|
||||||
## 🚀 Initial Setup Steps
|
|
||||||
|
|
||||||
1. Clone the Repository
|
|
||||||
```bash
|
|
||||||
git clone [your-repository-url]
|
|
||||||
cd dyolink/backend
|
|
||||||
|
|
||||||
2. Install Dependencies
|
|
||||||
bash
|
|
||||||
npm install
|
|
||||||
|
|
||||||
3. Environment Configuration
|
|
||||||
Create a .env file in the backend folder:
|
|
||||||
env
|
|
||||||
# backend/.env
|
|
||||||
DATABASE_URL=postgresql://postgres:1234@localhost:5432/dyolink_db
|
|
||||||
JWT_SECRET=your-super-secret-key-here-change-this
|
|
||||||
JWT_REFRESH_SECRET=your-super-secret-refresh-key-here-different-from-above
|
|
||||||
JWT_EXPIRES_IN=15m
|
|
||||||
JWT_REFRESH_EXPIRES_IN=7d
|
|
||||||
PORT=3000
|
|
||||||
⚠️ Important: Never commit the .env file to git! We have .gitignore set up to prevent this.
|
|
||||||
|
|
||||||
4. Database Setup
|
|
||||||
Option A: Fresh PostgreSQL Installation
|
|
||||||
If you don't have PostgreSQL installed:
|
|
||||||
Windows (using Chocolatey):
|
|
||||||
bash
|
|
||||||
choco install postgresql
|
|
||||||
macOS (using Homebrew):
|
|
||||||
bash
|
|
||||||
brew install postgresql@15
|
|
||||||
brew services start postgresql@15
|
|
||||||
Common Installation Issues & Fixes:
|
|
||||||
Issue Solution
|
|
||||||
"Password not set during installation" Edit pg_hba.conf temporarily (see Troubleshooting section)
|
|
||||||
"Service not starting" Run PowerShell/Terminal as Administrator
|
|
||||||
"Port 5432 already in use" Stop local PostgreSQL service or change port
|
|
||||||
Option B: Using Existing PostgreSQL
|
|
||||||
If you already have PostgreSQL:
|
|
||||||
bash
|
|
||||||
# Connect to PostgreSQL
|
|
||||||
psql -U postgres
|
|
||||||
# Create the database (if it doesn't exist)
|
|
||||||
CREATE DATABASE dyolink_db;
|
|
||||||
\q
|
|
||||||
|
|
||||||
5. Database Migrations
|
|
||||||
Once PostgreSQL is running and you've created the database:
|
|
||||||
bash
|
|
||||||
# Generate Prisma client
|
|
||||||
npx prisma generate
|
|
||||||
# Run migrations to create tables
|
|
||||||
npx prisma migrate dev --name init_schema
|
|
||||||
⚠️ Known Issue: If you get P1001: Can't reach database server, ensure PostgreSQL is running:
|
|
||||||
bash
|
|
||||||
# Check PostgreSQL status
|
|
||||||
# Windows:
|
|
||||||
Get-Service postgresql-x64-18
|
|
||||||
# macOS:
|
|
||||||
brew services list | grep postgres
|
|
||||||
|
|
||||||
6. Seed the Database
|
|
||||||
bash
|
|
||||||
# Seed with initial data (organization types, plans, permissions, test user)
|
|
||||||
npx prisma db seed
|
|
||||||
⚠️ Prisma 7 Note: If seeding fails with PrismaClientInitializationError, we've fixed this by using the driver adapter pattern. The seed file now uses:
|
|
||||||
typescript
|
|
||||||
import { PrismaPg } from '@prisma/adapter-pg';
|
|
||||||
import { Pool } from 'pg';
|
|
||||||
const adapter = new PrismaPg(pool);
|
|
||||||
const prisma = new PrismaClient({ adapter });
|
|
||||||
7. Verify Setup
|
|
||||||
bash
|
|
||||||
# Open Prisma Studio to verify data
|
|
||||||
npx prisma studio
|
|
||||||
# This opens http://localhost:5555 - you should see all tables with seeded data
|
|
||||||
8. Start Development Server
|
|
||||||
bash
|
|
||||||
npm run start:dev
|
|
||||||
You should see:
|
|
||||||
text
|
|
||||||
Application is running on: http://localhost:3000
|
|
||||||
✅ Database connected successfully
|
|
||||||
@@ -8,22 +8,22 @@ echo "=========================================="
|
|||||||
if [ "$NODE_ENV" = "production" ]; then
|
if [ "$NODE_ENV" = "production" ]; then
|
||||||
echo "Running in PRODUCTION mode"
|
echo "Running in PRODUCTION mode"
|
||||||
echo "Running database migrations..."
|
echo "Running database migrations..."
|
||||||
npx prisma migrate deploy
|
./node_modules/.bin/prisma migrate deploy
|
||||||
else
|
else
|
||||||
echo "Running in DEVELOPMENT mode"
|
echo "Running in DEVELOPMENT mode"
|
||||||
echo "Syncing database schema..."
|
echo "Syncing database schema..."
|
||||||
npx prisma db push
|
./node_modules/.bin/prisma db push
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [ "$NODE_ENV" != "production" ]; then
|
if [ "$NODE_ENV" != "production" ]; then
|
||||||
if [ -f "prisma/seed.ts" ] || [ -f "prisma/seed.js" ]; then
|
if [ -f "prisma/seed.ts" ] || [ -f "prisma/seed.js" ]; then
|
||||||
echo "Running database seed..."
|
echo "Running database seed..."
|
||||||
npx prisma db seed
|
./node_modules/.bin/prisma db seed
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
echo "Verifying database connection..."
|
echo "Verifying database connection..."
|
||||||
if ! echo "SELECT 1" | npx prisma db execute --stdin --schema prisma/schema.prisma >/dev/null 2>&1; then
|
if ! echo "SELECT 1" | ./node_modules/.bin/prisma db execute --stdin --schema prisma/schema.prisma >/dev/null 2>&1; then
|
||||||
echo "Cannot connect to database or execute query."
|
echo "Cannot connect to database or execute query."
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|||||||
16353
backend/package-lock.json
generated
Normal file
16353
backend/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
@@ -41,6 +41,7 @@
|
|||||||
"@nestjs/swagger": "^11.2.6",
|
"@nestjs/swagger": "^11.2.6",
|
||||||
"@nestjs/throttler": "^6.5.0",
|
"@nestjs/throttler": "^6.5.0",
|
||||||
"@prisma/client": "^6.19.2",
|
"@prisma/client": "^6.19.2",
|
||||||
|
"prisma": "^6.19.2",
|
||||||
"adminjs": "^7.8.17",
|
"adminjs": "^7.8.17",
|
||||||
"axios": "^1.13.5",
|
"axios": "^1.13.5",
|
||||||
"bcrypt": "^6.0.0",
|
"bcrypt": "^6.0.0",
|
||||||
@@ -84,7 +85,6 @@
|
|||||||
"globals": "^16.0.0",
|
"globals": "^16.0.0",
|
||||||
"jest": "^30.0.0",
|
"jest": "^30.0.0",
|
||||||
"prettier": "^3.4.2",
|
"prettier": "^3.4.2",
|
||||||
"prisma": "^6.19.2",
|
|
||||||
"source-map-support": "^0.5.21",
|
"source-map-support": "^0.5.21",
|
||||||
"supertest": "^7.0.0",
|
"supertest": "^7.0.0",
|
||||||
"ts-jest": "^29.2.5",
|
"ts-jest": "^29.2.5",
|
||||||
@@ -94,6 +94,10 @@
|
|||||||
"typescript": "^5.7.3",
|
"typescript": "^5.7.3",
|
||||||
"typescript-eslint": "^8.20.0"
|
"typescript-eslint": "^8.20.0"
|
||||||
},
|
},
|
||||||
|
"overrides": {
|
||||||
|
"@tiptap/core": "2.27.2",
|
||||||
|
"@tiptap/pm": "2.27.2"
|
||||||
|
},
|
||||||
"jest": {
|
"jest": {
|
||||||
"moduleFileExtensions": [
|
"moduleFileExtensions": [
|
||||||
"js",
|
"js",
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
import { BadRequestException, Injectable, NotFoundException } from '@nestjs/common';
|
import { BadRequestException, Injectable, NotFoundException } from '@nestjs/common';
|
||||||
import { Prisma } from '@prisma/client';
|
|
||||||
import { PrismaService } from '../../../prisma/prisma.service';
|
import { PrismaService } from '../../../prisma/prisma.service';
|
||||||
import { CreatePatientDto } from './dto/create-patient.dto';
|
import { CreatePatientDto } from './dto/create-patient.dto';
|
||||||
import { ListPatientsDto } from './dto/list-patients.dto';
|
import { ListPatientsDto } from './dto/list-patients.dto';
|
||||||
@@ -26,15 +25,15 @@ export class PatientsService {
|
|||||||
const { page = 1, limit = 10, q } = query;
|
const { page = 1, limit = 10, q } = query;
|
||||||
const skip = (page - 1) * limit;
|
const skip = (page - 1) * limit;
|
||||||
|
|
||||||
const where: Prisma.PatientWhereInput = {
|
const where = {
|
||||||
organizationId,
|
organizationId,
|
||||||
...(q
|
...(q
|
||||||
? {
|
? {
|
||||||
OR: [
|
OR: [
|
||||||
{ firstName: { contains: q, mode: 'insensitive' } },
|
{ firstName: { contains: q, mode: 'insensitive' as const } },
|
||||||
{ lastName: { contains: q, mode: 'insensitive' } },
|
{ lastName: { contains: q, mode: 'insensitive' as const } },
|
||||||
{ email: { contains: q, mode: 'insensitive' } },
|
{ email: { contains: q, mode: 'insensitive' as const } },
|
||||||
{ phone: { contains: q, mode: 'insensitive' } },
|
{ phone: { contains: q, mode: 'insensitive' as const } },
|
||||||
],
|
],
|
||||||
}
|
}
|
||||||
: {}),
|
: {}),
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
{
|
{
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
|
"types": ["node", "jest"],
|
||||||
"module": "nodenext",
|
"module": "nodenext",
|
||||||
"moduleResolution": "nodenext",
|
"moduleResolution": "nodenext",
|
||||||
"resolvePackageJsonExports": true,
|
"resolvePackageJsonExports": true,
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
# Build stage — produces `.next/standalone` (see next.config.ts output: standalone)
|
# Build stage — produces `.next/standalone` (see next.config.ts output: standalone)
|
||||||
FROM node:18-alpine AS builder
|
FROM node:20-alpine AS builder
|
||||||
|
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|
||||||
@@ -21,7 +21,7 @@ ENV NEXT_PUBLIC_APP_NAME=${NEXT_PUBLIC_APP_NAME}
|
|||||||
RUN npm run build
|
RUN npm run build
|
||||||
|
|
||||||
# Production — minimal runtime using Next.js standalone bundle
|
# Production — minimal runtime using Next.js standalone bundle
|
||||||
FROM node:18-alpine AS runner
|
FROM node:20-alpine AS runner
|
||||||
|
|
||||||
RUN apk add --no-cache dumb-init
|
RUN apk add --no-cache dumb-init
|
||||||
|
|
||||||
|
|||||||
@@ -1,36 +1,63 @@
|
|||||||
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
|
# Dyolink — Frontend (Next.js)
|
||||||
|
|
||||||
## Getting Started
|
## Prerequisites
|
||||||
|
|
||||||
First, run the development server:
|
- **Node.js 20+** and **npm**
|
||||||
|
|
||||||
|
## First-time setup
|
||||||
|
|
||||||
|
1. **Clone the monorepo** and go to the frontend app:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone <repository-url> dyolink
|
||||||
|
cd dyolink/frontend
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **Install dependencies**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Environment**
|
||||||
|
|
||||||
|
Create **`.env.local`** in this folder (not committed to git) with the public URLs your browser will use:
|
||||||
|
|
||||||
|
```env
|
||||||
|
NEXT_PUBLIC_APP_URL=http://localhost:3001
|
||||||
|
NEXT_PUBLIC_API_URL=http://localhost:3000/api
|
||||||
|
NEXT_PUBLIC_APP_NAME=Dyolink
|
||||||
|
```
|
||||||
|
|
||||||
|
- Adjust **`NEXT_PUBLIC_API_URL`** if the Nest API runs on another host/port.
|
||||||
|
- These values are baked in at **build time** for production images; for local dev, restart `npm run dev` after changing them.
|
||||||
|
|
||||||
|
## Run (development)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run dev
|
npm run dev
|
||||||
# or
|
|
||||||
yarn dev
|
|
||||||
# or
|
|
||||||
pnpm dev
|
|
||||||
# or
|
|
||||||
bun dev
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
Open **`http://localhost:3001`** (dev server uses port **3001** so it does not clash with the API on 3000).
|
||||||
|
|
||||||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
Ensure the backend is running and `NEXT_PUBLIC_API_URL` matches its base URL (including `/api` if your API is mounted there).
|
||||||
|
|
||||||
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
|
## After pulling latest `main`
|
||||||
|
|
||||||
## Learn More
|
```bash
|
||||||
|
git pull
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
To learn more about Next.js, take a look at the following resources:
|
## Useful commands
|
||||||
|
|
||||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
| Command | Purpose |
|
||||||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
|--------|---------|
|
||||||
|
| `npm run dev` | Development server (port 3001) |
|
||||||
|
| `npm run build` | Production build |
|
||||||
|
| `npm run start` | Serve production build (port 3000 — used inside Docker) |
|
||||||
|
| `npm run lint` | ESLint |
|
||||||
|
|
||||||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
|
## Docker
|
||||||
|
|
||||||
## Deploy on Vercel
|
Image build and build-args (`NEXT_PUBLIC_*`) are documented in the **repository root `README.md`**.
|
||||||
|
|
||||||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
|
|
||||||
|
|
||||||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
|
|
||||||
|
|||||||
6797
frontend/package-lock.json
generated
Normal file
6797
frontend/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user