Giter Club home page Giter Club logo

enkor-bnb's Introduction

enkor-bnb

제출물 보러가기

필수 스택

  • Node.js 14 이상
  • Express.js
  • MySQL or Sqlite
  • Typescript or Javascript

구현 기능

숙박 플랫폼을 서비스하기 위한 REST API를 구현해야 합니다.

  • 회원 기능
    • 회원 가입
    • 로그인
    • 회원 가입 및 로그인은 이메일을 사용합니다.
    • 비밀번호는 암호화 되어야 합니다.
    • JWT만을 이용해 인증기능이 구현되어야 합니다.
  • 매물 조회 기능
    • 매물 정보: 타이틀, 주변대학, 매물 타입, 이미지 URL, 설명, 주소, 가격.
    • 사용자는 매물 리스트를 볼 수 있어야 합니다. 페이지네이션이 필요합니다. 리스트에는 타이틀, 주변대학, 이미지, 매물 타입, 가격이 나옵니다.
    • 사용자는 상품 리스트를 가격순으로 정렬할 수 있습니다.
    • 사용자는 상품 상세 정보를 볼 수 있어야 합니다.
  • 숙박 예약
    • 사용자는 숙박 시설을 예약할 수 있어야 합니다.
    • 사용자는 예약한 내용을 확인할 수 있어야 합니다.

우대사항

  • 유닛 테스트
  • 문서화

Submission

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# unit test
$ npm run test

Environment variable

Key Required
PORT
DB_HOST O
DB_USER O
DB_DATABASE O
DB_PASSWORD O
BCRYPT_SALT
JWT_SECRET O
JWT_EXPIRES_IN

Completed feature

  • 회원 가입
    • 비밀번호 암호화
  • 로그인
    • JWT 인증
  • 모든 매물 조회
    • 페이지네이션
    • 가격순 정렬
  • 매물 상세 정보 조회
  • 숙박 예약
  • 예약 내용 조회
  • Swagger 문서화
  • 유닛 테스트

API Summary

URL Method Description
/api-docs GET API 문서 조회
/api/users/join POST 회원 가입
/api/users/login POST 로그인
/api/houses GET 모든 매물 조회
/api/houses/{id} GET 매물 상세 정보 조회
/api/reservations POST 숙박 예약
/api/reservations GET 예약 조회

ERD

ERD

enkor-bnb's People

Contributors

annahxxl avatar seanjo-com avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.