Project Title

Table of Contents

• [1] About the Project
  • Features
  • Technologies
• [2] Getting Started
  • Prerequisites
  • Installation
  • Configuration
• [3] Usage
• [4] Contribution
• [5] Acknowledgement
• [6] Contact
• [7] License

[1] About the Project

다음 내용을 고려하여 프로젝트에 대한 전반적인 정보를 적으세요.

• ❗️짧은❗️ 도입부/제작 동기
• 무슨 프로젝트인지
• 왜 이 프로젝트를 사용해야하는지

Features

강조하고 싶은 주요 기능이나 차별성 있는 특징을 적으세요.

• 최고 멋진 README를 쉽게 작성할 수 있도록 이텔릭체로 된 가이드를 제공
• 뱃지로 언어 옵션을 제공

Technologies

언어, 프레임워크, 주요 라이브러리를 버전과 함께 나열하세요.

• Maven 3.6.3
• MySQL 8.0
• Spring 2.4.3

[2] Getting Started

만약 운영체제에 따라 프로그램을 다르게 동작시켜야한다면, 운영체제별로 동작 방법을 설명하세요

Prerequisites

프로젝트를 동작시키기 위해 필요한 소프트웨어와 라이브러리를 나열하고 어떻게 다운받을 수 있는지 설명하세요.

• OpenWeather API key (무료)
• npm

npm install npm@latest -g

Installation

어떻게 이 프로젝트의 소스코드를 다운받을 수 있는지 설명하세요.

1. Repository 클론

git clone https://github.com/your-username/project-repository

2. NPM packages 설치

npm install

Configuration

코드의 어느 부분을 채우거나 수정해야하는지 설명하세요.

• config.js에 Openweather API key를 입력

const API_KEY = "<Your API key>";

[3] Usage

스크린샷, 코드 등을 통해 사용 방법과 사용 예제를 보여주세요. 사용 예제별로 h2 헤더로 나누어 설명할 수 있습니다.

// 몇 개의 API 사용 예제를 코드와 함께 보여주세요.

[4] Contribution

기여해주신 모든 분들께 대단히 감사드립니다.contributing guide를 참고해주세요. 이 프로젝트의 기여하신 분들을 소개합니다! 🙆‍♀️ 이모티콘 쓰는 것을 좋아한다면, 버그 수정에 🐞, 아이디어 제공에 💡, 새로운 기능 구현에 ✨를 사용할 수 있습니다.

• 🐞 dev-ujin: 메인페이지 버그 수정

[5] Acknowledgement

유사한 프로젝트의 레포지토리 혹은 블로그 포스트 등 프로젝트 구현에 영감을 준 출처에 대해 링크를 나열하세요.

• Readme Template - Embedded Artistry
• How to write a kickass Readme - James.Scott
• Best-README-Template - othneildrew
• Img Shields
• Github Pages

[6] Contact

• 📧 dev.ujin518@gmail.com
• 📋 https://dev-ujin.github.io/contact

[7] License

MIT 라이센스 라이센스에 대한 정보는 LICENSE에 있습니다.