README.md

좋은 사람들과의 잊을 수 없는 여행

🏝 Go Together Admin

📑 Table of Contents

• 🚀 Quick Start
• 🗓 Project Duration
• ✨ Project Summary
  • Problems & Company's Requirements
• 👀 Demo
  • Live Website
  • How to Add Product
• 🪄 Tech Stack & Tools
  • Design Tools
  • Front-End Tech Stack
  • Back-End Tech Stack
  • Other Tools
• 🧑‍🤝‍🧑 Roles & Responsibilities

🚀 Quick Start

1. Clone this repo: git clone https://github.com/gotogether-s/gotogether-s-admin.git
2. Move to the directory: cd <YOUR_PROJECT_NAME>.
3. Install packages: yarn install
4. Start project
   • Localhost: yarn run dev
   • After build: yarn build then yarn run dev
5. Please contact [email protected] if you need an env key to run the project
6. Reference
   • Visit the live website: https://gotogether-s-admin.vercel.app
   • View project code with GitHub: https://github.com/gotogether-s/gotogether-s-admin

🗓 Project Duration

Sep 27, 2022 - Oct 12, 2022

Timeline

• Version 0.1.0 released: Feb 8, 2023

✨ Project Summary

Go Together is a travel service platform where people can book vacation packages. The service targets mainly seniors who have more challenge planning travel. GoTogether admin website is for the business administrator to add vacation pacakges products to their service website.

• Client: Go Together Travel Agency
• Service: Website Design & Development
• Team Members: 2

Problems & Company's Requirements

The existing website of Go Together was created with a CMS (Content Management System) called I'm Web, allowing limited functions. The Shiny, which operates the Go Together service, requested the creation of a new website that reflects the following three requirements:

1. Web page renewal based on the mobile layout
2. Vacation packages recommendation function tailored to users' interest (Click here to see Go Together Service Github repo)
3. Create an admin page that allows product registration ✅

👀 Demo

Live Website

🔗 Visit the live website on Vercel

How to Add Product

1. Sign in to admin account

2. Fill out all the required input

3. Add new product

🪄 Tech Stack & Tools

Design Tools

• For wireframe and mockup creation: Adobe XD

Front-End Tech Stack

🔗 GitHub Repo: https://github.com/gotogether-s/gotogether-s-admin

• Framework: Next.js
• Programming Language: JavaScript
• Router: next/router
• State Management: Redux toolkit
• API Request: axios
• Design: MUI, Scss, CSS Module

Back-End Tech Stack

🔗 GitHub Repo: https://github.com/gotogether-s/gotogether-s-BE

🔗 ERD Cloud: https://www.erdcloud.com/d/bdPHHqeiiKZ6GC9rP

• Programming Language: Java
• Framework & DB: IntelliJ, Gradle, Spring, Spring Boot, Data JPA, Security, JWT, MySQL
• CI/CD & Infrastructure: Jenkins, Docker, EC2, RDS, S3
• Other: POSTMAN, ERD Cloud

Other Tools

• Issue: Github Issue
• Documentation: Notion
• Communication: Slack, Discord, Zoom

🧑‍🤝‍🧑 Roles & Responsibilities

Hyeonah (Front-End Development)	Hyeonseung (Back-End Development)
@hyeonahc	@iheese
Design mockup, Create admin Sign in page, Create add product page	Product API (create, read, update and delete)