diff --git a/README.md b/README.md index 28ad4c8..f0f6d3e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,184 @@ - + + + -웹 서비스 가보자고 → [Piickle](https://www.piickle.link/?utm_content=git1.2) + + + + +[![Contributors][contributors-shield]][contributors-url] +[![Forks][forks-shield]][forks-url] +[![Stargazers][stars-shield]][stars-url] +[![Issues][issues-shield]][issues-url] +[![MIT License][license-shield]][license-url] + + + + +
+
+ +[//]: # ( ) + +[//]: # ( Logo) + +[//]: # ( ) + +

Piickle server

+ +

+ 웹서비스 피클의 서버 저장소 +
+
+ View Demo + · + Report Bug + · + Request Feature +

+
+ + + + +## 🥒 Piickle +### 지금 내게 필요한 대화주제 추천 서비스, 피클! + + + +

(back to top)

+ + + +
+ +## Service Preview + +### 1. Main + + +### 2. Category + + + +### 3. Card + + +### 4. My Piickle + + + +### 5. Piickle Me + + + +### 6. My Page + + + +
+ + + +## Getting Started + +This is an example of how you may give instructions on setting up your project locally. +To get a local copy up and running follow these simple example steps. + +### Installation + +1. Clone the repo + ```sh + git clone https://github.com/TeamPiickle/server.git + ``` +2. Install yarn packages + ```sh + yarn + ``` +3. Enter your credentials in `.env` +4. Change git remote url to avoid accidental pushes to base project + ```sh + git remote set-url origin TeamPiickle/server + git remote -v # confirm the changes + ``` + +

(back to top)

+ + + +### Top contributors: + + + contrib.rocks image + + + + + +## License + +Distributed under the MIT License. See `LICENSE.txt` for more information. + +

(back to top)

+ + + + +## Contact + +Kayoung Yoon - dev.kayoung@gmail.com + +Project Link: [https://github.com/TeamPiickle/server](https://github.com/TeamPiickle/server) + +

(back to top)

+ + + + + + +[contributors-shield]: https://img.shields.io/github/contributors/TeamPiickle/server.svg?style=for-the-badge +[contributors-url]: https://github.com/TeamPiickle/server/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/TeamPiickle/server.svg?style=for-the-badge +[forks-url]: https://github.com/TeamPiickle/server/network/members +[stars-shield]: https://img.shields.io/github/stars/TeamPiickle/server.svg?style=for-the-badge +[stars-url]: https://github.com/TeamPiickle/server/stargazers +[issues-shield]: https://img.shields.io/github/issues/TeamPiickle/server.svg?style=for-the-badge +[issues-url]: https://github.com/TeamPiickle/server/issues +[license-shield]: https://img.shields.io/github/license/TeamPiickle/server.svg?style=for-the-badge +[license-url]: https://github.com/TeamPiickle/server/blob/master/LICENSE.txt +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 +[linkedin-url]: https://linkedin.com/in/linkedin_username +[product-screenshot]: images/screenshot.png