Skip to content

Latest commit

 

History

History
89 lines (69 loc) · 2.4 KB

README-en.md

File metadata and controls

89 lines (69 loc) · 2.4 KB

🏆Coffee Worldcup🏆

Coffee Worldcup is a website where you can select your favorite coffee brands and options, and use the KakaoTalk sharing feature to request a gifticon from your friends.

Translation Versions: ENGLISH | 한국어

dream-coffee-world-demo dream-coffee-worldcup-kakao-share-result

📜Tech Stacks

  • React 19.0.0

🌐Deployment

  • Netlify

💻Development Environment(IDE)

  • Visual Studio Code

🖥️How to Set Up and Run Locally

  1. Clone the project
git clone https://github.com/HJ0216/dream-coffee-worldcup.git
cd dream-coffee-worldcup
  1. Install npm libraries
npm install styled-component
npm install react-router-dom
npm install js-confetti
  1. Set Kakao API Key Create a .env file in the root folder of the project and add the Kakao API key
REACT_APP_KAKAO_JS_API_KEY = "YOUR_KAKAO_API_KEY"
  1. Run the project
npm start

🗒️Commit Message Rule

✨Feat: #issue_number Add a new feature
🐛Fix: #issue_number Fix a bug
📝Docs: #issue_number Update or add documentation (e.g., README.md)
🎨Style: #issue_number Format code, rename functions, etc.
💄Design: #issue_number Update user interface design
✅Test: #issue_number Add or modify test code
♻️Refactor: #issue_number Refactor code
🧹Chore: #issue_number Miscellaneous minor updates
🚚Rename: #issue_number Rename files or folders only
🔥Remove: #issue_number Delete files only

📂Folder Structure

📦src
 ┣ 📂assets
 ┃ ┗ 📂images
 ┃ ┃ ┣ 📂brands
 ┃ ┃ ┗ 📂etc
 ┣ 📂components
 ┣ 📂pages
 ┣ 📂styles
 ┣ 📜App.js
 ┗ 📜index.js

⭐Contributions

If you have suggestions for how Dream-coffee-worldcup could be improved, or want to report a bug, open an issue!
I'd love all and any contributions.

For more, check out the Contributing Guide.