u-jinlee/steam-project

Spring Boot 3.0 Skeleton Project

Table of Contents

• 개요
• Skill
• Installation
• Running Tests
• API Reference
• 프로젝트 진행 및 이슈 관리
• 구현과정(설계 및 의도)
• TIL 및 회고
• Authors(Optional)
• References

개요

이 서비스가 어떠한 배경에서 발견한 문제상황을 해결하기 위해 시작되었는지 및 어떠한 방법으로 해당 문제를 해결하려 하는지 등...

주요기능

1. 해당 프로젝트가 어떠한 기능을 하는지를 이곳에 간단히 정리

Skill

Installation

  # Package 설치
  npm install my-project
  cd my-project
  
  # 초기 설정 : 데이터 및  스케쥴러 실행
  npm install my-project
  cd my-project

Running Tests

To run tests, run the following command

  ./gradlew test

API Reference

Get all items - click

Request

  GET /api/items

Parameter	Type	Description
api_key	string	Required. Your API key

Response

    HTTP/1.1 200
    Content-Type: application/json

    [{
        "id": 10,
        "name": "shirt",
        "color": "red",
        "price": "$23"
    },...
    ]

Get all items - click

Request

  GET /api/items

Parameter	Type	Description
api_key	string	Required. Your API key

Response

    HTTP/1.1 200
    Content-Type: application/json

    [{
        "id": 10,
        "name": "shirt",
        "color": "red",
        "price": "$23"
    },...
    ]

Get all items - click

Request

  GET /api/items

Parameter	Type	Description
api_key	string	Required. Your API key

Response

    HTTP/1.1 200
    Content-Type: application/json

    [{
        "id": 10,
        "name": "shirt",
        "color": "red",
        "price": "$23"
    },...
    ]

프로젝트 진행 및 이슈 관리

구현과정(설계 및 의도)

(노션, 블로그 등의 페이지로 안내 가능)

유저 모델과 실행결과 모델관의 관계 설정 시 00 고려 - click

• 의존성 문제
  1. Press Ctrl + f on your keyboard, to bring out the search modal.
  2. Enter the name of the badge you need.
  3. Copy the appropriate ![Name](link) element and paste it in your Markdown file (e.g. README.md)
• 00가 00 하는 문제

00 구현 시 동시성 고려 - click

• 의존성 문제
  1. Press Ctrl + f on your keyboard, to bring out the search modal.
  2. Enter the name of the badge you need.
  3. Copy the appropriate ![Name](link) element and paste it in your Markdown file (e.g. README.md)
• 00가 00 하는 문제

RESTful API 설계 - click

• 의존성 문제
  1. Press Ctrl + f on your keyboard, to bring out the search modal.
  2. Enter the name of the badge you need.
  3. Copy the appropriate ![Name](link) element and paste it in your Markdown file (e.g. README.md)
• 00가 00 하는 문제

TIL 및 회고

Django ORM 조회 시 발생하는 00 버그 - click

• 의존성 문제
  1. Press Ctrl + f on your keyboard, to bring out the search modal.
  2. Enter the name of the badge you need.
  3. Copy the appropriate ![Name](link) element and paste it in your Markdown file (e.g. README.md)
• 00가 00 하는 문제

Django ORM 조회 시 발생하는 00 버그 - click

• 의존성 문제

  1. Press Ctrl + f on your keyboard, to bring out the search modal.
  2. Enter the name of the badge you need.
  3. Copy the appropriate ![Name](link) element and paste it in your Markdown file (e.g. README.md)

• 00가 00 하는 문제

(또는 블로그, 노션 등 링크 연동)

• Django ORM 조회 시 발생하는 00 버그 발생
• 00 서비스 개발 회고록

Authors(Optional)

이유진	팀원	팀원	팀원	팀원
@U-jinLee	@team1	@team2	@team3	@team4

References

• Awesome Readme Templates
• Awesome README
• How to write a Good readme