Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: README 작성 #160

Merged
merged 4 commits into from
Oct 2, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 96 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,96 @@
# dnd-11th-5-backend
.
<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->

<a id="readme-top"></a>

<!--
*** Thanks for checking out the Best-README-Template. If you have a suggestion
*** that would make this better, please fork the repo and create a pull request
*** or simply open an issue with the tag "enhancement".
*** Don't forget to give the project a star!
*** Thanks again! Now go create something AMAZING! :D
-->

<!-- PROJECT SHIELDS -->
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->

<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://github.com/dnd-side-project/dnd-11th-5-backend">
<img src="https://i.imgur.com/7KKMWFz.png" alt="Logo" width="500">
</a>

<h3 align="center">Fiesta</h3>

<p align="center">
다양한 분류를 통해 지역 축제 정보를 제공하는 웹 플랫폼
<br />
<a href="https://github.com/dnd-side-project/dnd-11th-5-backend"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://fiesta-psi.vercel.app/">프론트엔드 배포 URL</a>
·
<a href="https://odiga.shop/swagger-ui/index.html">API 명세 (Swagger)</a>
·
<a href="https://github.com/dnd-side-project/dnd-11th-5-backend/wiki">Wiki</a>
</p>
</div>

<!-- TABLE OF CONTENTS -->
<details>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#built-with">Built With</a></li>
<li><a href="#project-structure">Project Structure</a></li>
</ul>
</li>
</ol>
</details>

<!-- ABOUT THE PROJECT -->

## About The Project

<img src="https://i.imgur.com/20lTOkP.png" alt="Logo" width="500">

Fiesta는 공공데이터 기반의 지역 축제 정보를 다양한 검색 조건을 이용하여 사용자에게 제공합니다.

**주요 기능**

- 사용자 설문조사를 통한 사용자 유형 분류
- 사용자 유형에 따른 추천 축제 제공
- 다양한 조건에 대한 페스티벌 정보 제공
- 다가오는 페스티벌 조회
- 북마크 순 페스티벌 조회
- 거리 순 페스티벌 조회
- 각 축제에 대한 리뷰 기능

<p align="right">(<a href="#readme-top">back to top</a>)</p>

> **프로젝트에 대한 더욱 자세한 정보는 [Wiki](https://github.com/dnd-side-project/dnd-11th-5-backend/wiki)를 참고해주세요!**

### Project Structure

![Drawing 2024-08-28 21 31 16 excalidraw](https://github.com/user-attachments/assets/69025b16-cb41-4f75-b3d5-b216dddc4b5e)

### Built With

- Java 21
- Spring Boot
- MySQL
- Spring Data JPA
- QueryDSL
- Redis
- Docker
- Github Actions

<p align="right">(<a href="#readme-top">back to top</a>)</p>
Loading