TIL - Github README 작성

KDG·2020년 7월 4일
0

README.md

  • github에서 README.md는 레포에 담긴 내용을 전체적으로 설명하는 내용이 담긴다.

  • README.md 끝에 붙은 md는 마크다운의 약자로 마크다운 형식으로 작성된다.

  • 아래는 내가 프로젝트를 하고 작성한 README.md 파일이다.

# introduction

* 영국 60년 정통 패션 브랜드 샌들, 슈즈, 부츠 등을 취급하는 세계적인 의류 기업 닥터마틴 클론 프로젝트
* 개발기간 : 2020.06.22 ~ 2020.07.03(약 2주)
* 개발인원 : 3 Front-end, 3 Back-end
* [Front-end Github](https://github.com/wecode-bootcamp-korea/9-Dr_strange-frontend)
* [Back-end Github](https://github.com/wecode-bootcamp-korea/9-Dr_strange-backend)

# Demo
[![](https://velog.velcdn.com/images%2Fdgk089%2Fpost%2Fa9f911a0-60f9-475b-9082-b44bb7712fa0%2F%EC%8A%A4%ED%81%AC%EB%A6%B0%EC%83%B7%2C%202020-07-04%2016-47-47.png)](https://youtu.be/x_OftNpGTy0)

# Model

![Model](https://velog.velcdn.com/images%2Fdgk089%2Fpost%2F5dbf5268-d445-4705-9e9c-27d3de238379%2F%EC%8A%A4%ED%81%AC%EB%A6%B0%EC%83%B7%2C%202020-07-04%2011-16-00.png)

# Technologies

* Python
* Django
* Beautifulsoup, Selenium
* Bcrypt
* JWT
* MySQL
* CORS headers
* Git, Github

# Features

* users
   - 유저정보저장
   - 회원가입 / 로그인
     - 회원가입시 유효성 검사
     - 회원가입시 패스워드 암호화
     - 로그인시 JWT Access 토큰 발행
   - 로그인 상태인지 확인하는 데코레이터 함수
   - 마이페이지
   
* product_app
   - 상품 리스트 구현
   - 상품 상세정보 구현
   - 상품 검색 구현
   - 상품 베스트셀러 구현
   
* cart_app
   - 장바구니 구현
      - 장바구니 추가 / 보기 / 삭제

# API Documentation

https://documenter.getpostman.com/view/9451840/T17FBoMA

  • 아래는 위의 형식이 적용된 README.md 파일이다.

introduction

  • 영국 60년 정통 패션 브랜드 샌들, 슈즈, 부츠 등을 취급하는 세계적인 의류 기업 닥터마틴 클론 프로젝트
  • 개발기간 : 2020.06.22 ~ 2020.07.03(약 2주)
  • 개발인원 : 3 Front-end, 3 Back-end
  • Front-end Github
  • Back-end Github

Demo

Model

Technologies

  • Python
  • Django
  • Beautifulsoup, Selenium
  • Bcrypt
  • JWT
  • MySQL
  • CORS headers
  • Git, Github

Features

  • users
    • 유저정보저장
    • 회원가입 / 로그인
      • 회원가입시 유효성 검사
      • 회원가입시 패스워드 암호화
      • 로그인시 JWT Access 토큰 발행
    • 로그인 상태인지 확인하는 데코레이터 함수
    • 마이페이지
  • product_app
    • 상품 리스트 구현
    • 상품 상세정보 구현
    • 상품 검색 구현
    • 상품 베스트셀러 구현
  • cart_app
    • 장바구니 구현
      • 장바구니 추가 / 보기 / 삭제

API Documentation

https://documenter.getpostman.com/view/9451840/T17FBoMA

0개의 댓글