https://github.com/cccwon2/taskify-api

Taskify API
https://github.com/cccwon2/taskify-api

nestjs postresql prisma supabase taskify taskify-api

Last synced: 8 months ago
JSON representation

Taskify API

• Host: GitHub
• URL: https://github.com/cccwon2/taskify-api
• Owner: cccwon2
• License: other
• Created: 2024-11-04T11:38:45.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-05T05:27:49.000Z (over 1 year ago)
• Last Synced: 2024-11-05T06:24:49.419Z (over 1 year ago)
• Topics: nestjs, postresql, prisma, supabase, taskify, taskify-api
• Language: TypeScript
• Homepage:
• Size: 663 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Taskify API

![NestJS](https://img.shields.io/badge/NestJS-10.0.0-E0234E?style=flat-square&logo=nestjs)

![TypeScript](https://img.shields.io/badge/TypeScript-5.1.3-3178C6?style=flat-square&logo=typescript)

![Prisma](https://img.shields.io/badge/Prisma-5.21.1-2D3748?style=flat-square&logo=prisma)

![Swagger](https://img.shields.io/badge/Swagger-8.0.1-85EA2D?style=flat-square&logo=swagger)

![PostgreSQL](https://img.shields.io/badge/PostgreSQL-Latest-4169E1?style=flat-square&logo=postgresql)

![JWT](https://img.shields.io/badge/JWT-10.2.0-000000?style=flat-square&logo=jsonwebtokens)

![Supabase](https://img.shields.io/badge/Supabase-Latest-3ECF8E?style=flat-square&logo=supabase)

## 📝 Description

Taskify는 협업을 위한 칸반 보드 서비스입니다. 사용자들은 대시보드를 생성하고, 팀원들을 초대하여 함께 작업할 수 있습니다.

## ✨ Features

- 🔐 Authentication (JWT)

  - 이메일 회원가입/로그인

  - 소셜 로그인 (Google, Kakao, Naver)

  - 토큰 갱신

- 📋 Dashboard Management

  - 대시보드 CRUD

  - 팀원 초대 및 관리

- 📊 Kanban Board

  - 컬럼 CRUD

  - 카드 CRUD

  - 카드 이미지 업로드

  - 카드 담당자 지정

  - 댓글 기능

- 👥 User Management

  - 프로필 수정

  - 프로필 이미지 업로드

## 🛠 Tech Stack

### Backend

- NestJS

- TypeScript

- Prisma (ORM)

- PostgreSQL

- Swagger

- JWT

- Passport

### Infrastructure

- Supabase

  - PostgreSQL Database

  - Storage Buckets

    - profiles: 프로필 이미지 저장

    - cards: 카드 이미지 저장

## 📦 Installation

```bash

$ npm install

```

## 🚀 Running the app

```bash

# development

$ npm run start

# watch mode

$ npm run start:dev

# production mode

$ npm run start:prod

```

## 🧪 Test

```bash

# unit tests

$ npm run test

# e2e tests

$ npm run test:e2e

# test coverage

$ npm run test:cov

```

## 📚 API Documentation

API 문서는 Swagger를 통해 제공됩니다.

- 개발 환경: http://localhost:5000/docs

## 🔧 Environment Variables

프로젝트 실행을 위해 다음과 같은 환경 변수가 필요합니다:

```env

# Supabase 설정

SUPABASE_URL="your-supabase-url"

SUPABASE_KEY="your-supabase-key"

SUPABASE_STORAGE_BUCKET_NAME="your-bucket-name"

# Database 설정 (Supabase PostgreSQL 연결 문자열)

DATABASE_URL="your-postgresql-connection-string"

# JWT 설정

JWT_SECRET="your-jwt-secret"

JWT_REFRESH_SECRET="your-jwt-refresh-secret"

# 포트 설정

PORT=5000

# OAuth 설정

GOOGLE_CLIENT_ID="your-google-client-id"

GOOGLE_CLIENT_SECRET="your-google-client-secret"

GOOGLE_CALLBACK_URL="http://localhost:3000/auth/google/callback"

KAKAO_CLIENT_ID="your-kakao-client-id"

KAKAO_CLIENT_SECRET="your-kakao-client-secret"

KAKAO_CALLBACK_URL="http://localhost:3000/auth/kakao/callback"

NAVER_CLIENT_ID="your-naver-client-id"

NAVER_CLIENT_SECRET="your-naver-client-secret"

NAVER_CALLBACK_URL="http://localhost:3000/auth/naver/callback"

```

## 📁 Project Structure

```

src/

├── auth/           # 인증 관련

├── user/           # 사용자 관련 (프로필 이미지 업로드 포함)

├── dashboard/      # 대시보드 관련

├── column/         # 컬럼 관련

├── card/           # 카드 관련 (카드 이미지 업로드 포함)

├── comment/        # 댓글 관련

├── invitation/     # 초대 관련

├── member/         # 멤버 관련

├── common/         # 공통 모듈

└── prisma/         # Prisma 설정

```

## 📄 License

이 프로젝트는 MIT 라이센스를 따릅니다. 자세한 내용은 [LICENSE](LICENSE) 파일을 참조하세요.