/OKRs-enterprise-api

OKRs Tool's API. An API powered by NestJS and PostgreSQL.

Primary LanguageTypeScriptMIT LicenseMIT

Nest Powered Codacy Badge codecov License Contributors Dependabot Open Source Love GitHub commit activity PRs Welcome forthebadge

Tool OKRs - NestJS + TypeORM + PostgresQL

Code 1 API nhỏ nhắn xinh xắn nhưng không hề đáng yêu về tool OKRs cho các Start Up nhỏ sử dụng! Ai có đóng góp gì thì mong các bạn tạo issue để cải thiện hơn ạ 🥳

Thành viên

| Harry Trần | Văn Đức | Minh Đức | Văn Quang

Cách run project

⚠️ Yêu cầu trước khi run project

  1. Có Docker Desktop bản stable
  2. NodeJS phiên bản LTS(hiện tại là 12.18.1)
  3. Cài đặt Yarn
  4. Laptop/PC ram ít nhất 8GB

Các bước chạy

  1. Bật Docker lên, nếu chưa có thì tải ở đây

  2. Tạo thêm file mới ở root project tên là .env và lấy dữ liệu copy từ file .env.example

  3. Run Docker Compose để chạy ngầm PostgresQL

docker-compose up -d
  1. Tải dependencies của app về
yarn
  1. Run migration DB vào container Postgres Database
yarn migration:run
  1. Ok, ngon rồi, bây giờ thì test API các thứ thôi! Nhớ thêm vào Header mục Authorization với Bearer Token từ khi Login vào nhé 😎