argon1025 / TILog-server

TILog-server

현재 이곳에서 TILog-v2 마이그레이션이 진행중입니다.

TILog server

blog platform for developers, TILog.
Frontend project is at another Repo
개발자를 위한 블로그 플랫폼 TILog 입니다.

View Service · Report Bug · Request Feature

Project Status

Last Release Build :

Team

• 프로젝트 관리
• Dockerize
• 데이터 베이스 설계
• 에러처리
• 포스트 서비스
• S3 파일 업로드
• 작업 큐 서비스
• Redis 캐시 서비스
• CircleCI 지속적 배포

• Comments 서비스
• Users 서비스
• Passport를 사용한 인증
• UserBlogCustomization 서비스

• 게시글 태그
• 태그 검색

Built With

• NestJS
• TypeScript
• MySQL
• typeORM
• Redis

ERD Diagram

Getting Started

1. Clone this Project

git clone https://github.com/argon1025/TILog-server.git

2. Move Project folder and Install npm module

cd TILog-server
npm install

3. Create environment file

// vi .env
// vi .end.dev

# Server Settings
SERVER_PORT=3000
SERVER_HOST=localhost

# CORS Settings
CORS_METHOD=GET,HEAD,PUT,PATCH,POST,DELETE,OPTIONS
CORS_ORIGIN=true
CORS_CREDENTIALS=true

# Database Settings
DB_PASSWORD=
DB_DATABASE=TILog
DB_USERNAME=TILog
DB_HOST=
DB_PORT=3306

# Redis storage Settings
REDIS_HOST=redis://localhost
REDIS_PORT=6379

# Passport Settings
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=
GITHUB_CALLBACK_URL=

# Session Settings
SESSION_SECRET=
SESSION_RESAVE=
SESSION_SAVEUNINITIALIZED=
## 24H
SESSION_COOKIE_MAXAGE=86400000

# Front Server Setting
REDIRECT_FRONT=http://localhost:8080/login

# S3 fileUpload settings
AWS_S3_BUCKET=
AWS_S3_ACCESS_KEY=
AWS_S3_KEY_SECRET=
MAXIMUM_IMAGE_FILE_SIZE_BYTES=10000000

# Post cursor Settings
POSTS_GET_CONTENT_LIMIT=30

# Throttle Settings
THROTTLE_TTL=60
THROTTLE_LIMIT=10

# Alert WebHook
ERROR_SLACK_WEBHOOK_URL=https://hooks.slack.com/

# Sentry
SENTRY_DNS=https://[e-mail]

4.Using Docker-compose to Run the Storage.

docker-compose up --build

Please Change the environment variable(Database password) in docker-compose.yml

5.Start serverApp

cd src
npm run start:dev

Please Change the environment variable(.env.dev)