Complete setup for docker. Add readme, and fix some bugs

This commit is contained in:
2025-03-17 12:59:06 +04:00
parent 46c040c642
commit f57f842783
14 changed files with 181 additions and 48 deletions

54
README.md Normal file
View File

@@ -0,0 +1,54 @@
# Chat
> Chat - это анонимный асинхронный webchat
## Стек
- Frontend:
- [TypeScript](https://www.typescriptlang.org)
- [React 19](https://react.dev)
- [Next.js](https://nextjs.org) 15 (App Router)
- [Tailwind CSS](https://tailwindcss.com/)
- [Yup](https://github.com/jquense/yup)
- [SWR](https://swr.vercel.app/ru)
- Backend:
- [TypeScript](https://www.typescriptlang.org)
- [Nest](https://nestjs.com) 11
- [TypeORM](https://typeorm.io)
- [Swagger UI](https://swagger.io) Express
- Database: [PostgreSQL](https://www.postgresql.org)
## Возможности
- Анонимный асинхронный чат на основе WebSockets
- Цветовое выделение разных пользователей
- Адаптивная верстка. Корректное отображение на мобильных устройствах, планшетах, ноутбуках, десктопах
- SSR ([Server-Side Rendering](https://nextjs.org/docs/pages/building-your-application/rendering/server-side-rendering))
- Валидация данных с помощью [Yup](https://github.com/jquense/yup)
- Структура проекта в соответствии с [Feature-Sliced Design](https://feature-sliced.design)
- Цветовая схема [Gruvbox](https://github.com/morhetz/gruvbox). Возможность переключения тёмной и светлой темы
- Запуск с помощью Docker контейнеров (используется Docker Compose)
## Скриншоты
|![](./screenshots/dark.png)|![](./screenshots/light.png)|
|-|-|
## Запуск
### Development
Database:
docker compose -f 'docker-compose.yml' up -d --build
Backend:
cd ./backend
npm install
npm run start:dev
Frontend:
cd ./frontend
npm install
npm run dev
### Production
docker compose -f 'docker-compose-all.yml' up -d --build

23
backend/Dockerfile Normal file
View File

@@ -0,0 +1,23 @@
# Use the official Node.js image as the base image
FROM node:20
# Set the working directory inside the container
WORKDIR /usr/src/app
# Copy package.json and package-lock.json to the working directory
COPY package*.json ./
# Install the application dependencies
RUN npm install
# Copy the rest of the application files
COPY . .
# Build the NestJS application
RUN npm run build
# Expose the application port
# EXPOSE 3000
# Command to run the application
CMD ["node", "dist/main"]

View File

@@ -7,7 +7,6 @@ import AppModule from '@/modules/app';
async function bootstrap() { async function bootstrap() {
const app = await NestFactory.create(AppModule); const app = await NestFactory.create(AppModule);
app.useGlobalPipes(new ValidationPipe()); app.useGlobalPipes(new ValidationPipe());
app.useWebSocketAdapter(new WsAdapter(app)); app.useWebSocketAdapter(new WsAdapter(app));
@@ -22,4 +21,4 @@ async function bootstrap() {
await app.listen(process.env.PORT ?? 8000); await app.listen(process.env.PORT ?? 8000);
} }
bootstrap(); void bootstrap();

View File

@@ -14,7 +14,6 @@ import MessageModule from '@/modules/message';
load: [config, databaseConfig], load: [config, databaseConfig],
}), }),
TypeOrmModule.forRoot(databaseConfig()), TypeOrmModule.forRoot(databaseConfig()),
MessageModule, MessageModule,
], ],
}) })

View File

@@ -2,16 +2,11 @@ import Message from '@/entities/message';
import { OnGatewayConnection, WebSocketGateway } from '@nestjs/websockets'; import { OnGatewayConnection, WebSocketGateway } from '@nestjs/websockets';
import { Socket } from 'socket.io'; import { Socket } from 'socket.io';
@WebSocketGateway(8002) @WebSocketGateway(8002, { transports: ['websocket'] })
export class MessageGateway implements OnGatewayConnection { export class MessageGateway implements OnGatewayConnection {
private clients: Socket[] = []; private clients: Socket[] = [];
handleConnection(client: Socket) { handleConnection = (client: Socket) => this.clients.push(client);
this.clients.push(client); sendMessage = (message: Message) =>
}
sendMessage = (message: Message) => {
console.log(message, this.clients.length);
this.clients.forEach((client) => client.send(JSON.stringify(message))); this.clients.forEach((client) => client.send(JSON.stringify(message)));
};
} }

View File

@@ -10,7 +10,7 @@ export class MessageService {
private messageRepository: Repository<Message>, private messageRepository: Repository<Message>,
) {} ) {}
getTopOfHistory = () => getTopOfHistory = (): Promise<Message[]> =>
this.messageRepository this.messageRepository
.createQueryBuilder('message') .createQueryBuilder('message')
.orderBy('message.id', 'DESC') .orderBy('message.id', 'DESC')

View File

@@ -1,6 +1,6 @@
services: services:
postgres: postgres:
container_name: postgres_container container_name: postgres
image: postgres image: postgres
environment: environment:
POSTGRES_USER: postgres POSTGRES_USER: postgres
@@ -12,10 +12,11 @@ services:
# ports: # ports:
# - "5432:5432" # - "5432:5432"
networks: networks:
- postgres - network
restart: unless-stopped restart: unless-stopped
backend: backend:
container_name: backend
build: ./backend build: ./backend
environment: environment:
DATABASE_HOST: postgres DATABASE_HOST: postgres
@@ -23,27 +24,25 @@ services:
DATABASE_USER: postgres DATABASE_USER: postgres
DATABASE_PASSWORD: pass2postgres DATABASE_PASSWORD: pass2postgres
DATABASE_DATABASE: chat DATABASE_DATABASE: chat
WEBSOCKETS_PORT: 8001 ports:
# ports: - "8002:8002"
# - "5000:5000" networks:
- network
depends_on: depends_on:
- postgres - postgres
frontend: frontend:
container_name: frontend
build: ./frontend build: ./frontend
environment:
NEXT_PUBLIC_BASE_PROTOCOL: http
NEXT_PUBLIC_BASE_DOMAIN: backend
NEXT_PUBLIC_BASE_PORT: 3000
NEXT_PUBLIC_WS_URL: ws://backend:8002/
NEXT_PUBLIC_API_PATTERN: /
ports: ports:
- "3000:3000" - "3000:3000"
networks:
- network
depends_on: depends_on:
- backend - backend
networks: networks:
postgres: network:
driver: bridge driver: bridge
volumes: volumes:

11
frontend/.env.production Normal file
View File

@@ -0,0 +1,11 @@
BACKEND_API_PROTOCOL=http
BACKEND_API_DOMAIN=backend
BACKEND_API_PORT=8000
NEXT_PUBLIC_BASE_PROTOCOL=http
NEXT_PUBLIC_BASE_DOMAIN=localhost
NEXT_PUBLIC_BASE_PORT=3000
NEXT_PUBLIC_WS_URL=ws://localhost:8002/
NEXT_PUBLIC_API_PATTERN=/api/

42
frontend/Dockerfile Normal file
View File

@@ -0,0 +1,42 @@
# Stage 0: Get base system
FROM node:20-alpine AS base
# Stage 1: Instal dependencies
FROM base AS dependencies
WORKDIR /application
COPY package*.json ./
RUN npm ci
# Stage 2: Build
FROM base AS builder
WORKDIR /application
COPY --from=dependencies /application/node_modules ./node_modules
COPY . .
ENV NEXT_TELEMETRY_DISABLED 1
RUN npm run build
# Stage 3: Start
FROM base AS runner
WORKDIR /application
ENV NODE_ENV production
ENV NEXT_TELEMETRY_DISABLED 1
RUN addgroup --system --gid 1001 nodejs
RUN adduser --system --uid 1001 nextjs
COPY --from=builder /application/public ./public
RUN mkdir .next
RUN chown nextjs:nodejs .next
COPY --from=builder --chown=nextjs:nodejs /application/.next/standalone ./
COPY --from=builder --chown=nextjs:nodejs /application/.next/static ./.next/static
USER nextjs
EXPOSE 3000
ENV PORT 3000
CMD HOSTNAME="0.0.0.0" node server.js

View File

@@ -9,16 +9,17 @@ const nextConfig = {
}, },
]; ];
}, },
images: { // images: {
remotePatterns: [ // remotePatterns: [
{ // {
protocol: process.env.NEXT_PUBLIC_BASE_PROTOCOL, // protocol: process.env.NEXT_PUBLIC_BASE_PROTOCOL,
hostname: process.env.NEXT_PUBLIC_BASE_DOMAIN, // hostname: process.env.NEXT_PUBLIC_BASE_DOMAIN,
port: process.env.NEXT_PUBLIC_BASE_PORT, // port: process.env.NEXT_PUBLIC_BASE_PORT,
}, // },
], // ],
}, // },
devIndicators: false, devIndicators: false,
output: "standalone",
}; };
export default nextConfig; export default nextConfig;

View File

@@ -20,7 +20,7 @@ export const Message = ({
? "borderBottomRightRadius" ? "borderBottomRightRadius"
: "borderBottomLeftRadius"]: 0, : "borderBottomLeftRadius"]: 0,
}} }}
className={`max-w-20 p-2`} className={`p-2`}
> >
{message.text} {message.text}
</div> </div>

View File

@@ -8,11 +8,13 @@ import { Message } from "./message";
export const MessagesList = () => { export const MessagesList = () => {
const { data: users, mutate: mutateUsers } = useSWR<IUser[]>("users"); const { data: users, mutate: mutateUsers } = useSWR<IUser[]>("users");
const { data: messages, mutate: mutateMessages } = useSWR( const {
"messages", data: messages,
MessageService.getTopOfHistory, mutate: mutateMessages,
{ revalidateOnFocus: false } isLoading: messagesLoading,
); } = useSWR("messages", MessageService.getTopOfHistory, {
revalidateOnFocus: false,
});
const { data: me } = useSWR<IUser>("me"); const { data: me } = useSWR<IUser>("me");
const [websocket, updateWebSocket] = useState<WebSocket>(); const [websocket, updateWebSocket] = useState<WebSocket>();
const bottomRef = useRef<HTMLDivElement>(null); const bottomRef = useRef<HTMLDivElement>(null);
@@ -20,8 +22,18 @@ export const MessagesList = () => {
const getUserColor = (userUUID: IUser["uuid"]) => const getUserColor = (userUUID: IUser["uuid"]) =>
users?.find((user) => user.uuid === userUUID)?.color; users?.find((user) => user.uuid === userUUID)?.color;
const updateMessageHandler = (websocket?: WebSocket) => {
if (websocket)
websocket.onmessage = (event) => {
mutateMessages([...(messages ?? []), JSON.parse(event.data)], {
revalidate: false,
});
};
};
useEffect(() => { useEffect(() => {
bottomRef.current?.scrollIntoView({ behavior: "smooth" }); bottomRef.current?.scrollIntoView({ behavior: "smooth" });
updateMessageHandler(websocket);
const newUsers: IUser[] = []; const newUsers: IUser[] = [];
messages?.forEach((message) => { messages?.forEach((message) => {
if ( if (
@@ -35,20 +47,18 @@ export const MessagesList = () => {
}, [messages]); }, [messages]);
useEffect(() => { useEffect(() => {
if (!websocket && messages && process.env.NEXT_PUBLIC_WS_URL) { if (!websocket && !messagesLoading && process.env.NEXT_PUBLIC_WS_URL) {
const websocket = new WebSocket(process.env.NEXT_PUBLIC_WS_URL); const websocket = new WebSocket(process.env.NEXT_PUBLIC_WS_URL);
websocket.onmessage = (event) => { updateMessageHandler(websocket);
mutateMessages([...(messages ?? []), JSON.parse(event.data)], { websocket.onclose = () => {
revalidate: false, setTimeout(() => {
}); updateWebSocket(undefined);
}; }, 1000);
websocket.onclose = function () {
setTimeout(() => updateWebSocket(undefined), 1000);
}; };
updateWebSocket(websocket); updateWebSocket(websocket);
} }
return () => websocket?.close(); return () => websocket?.close();
}, [websocket, messages]); }, [websocket, messagesLoading]);
return ( return (
<div className="max-w-full h-full overflow-auto flex flex-col gap-2"> <div className="max-w-full h-full overflow-auto flex flex-col gap-2">

BIN
screenshots/dark.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 93 KiB

BIN
screenshots/light.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB