Skip to content

Commit

Permalink
docs: README ์ž‘์„ฑ (#160)
Browse files Browse the repository at this point in the history
  • Loading branch information
punchdrunkard authored Oct 2, 2024
1 parent a51ef13 commit 50bc772
Showing 1 changed file with 96 additions and 2 deletions.
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>

0 comments on commit 50bc772

Please sign in to comment.