Skip to content

๐ŸŽช ์˜คํ”„๋ผ์ธ ์ด๋ฒคํŠธ์˜ ์ƒˆ๋กœ์šด ์‹œ๋Œ€๋ฅผ ์—ด ์˜คํ”ˆ;์˜คํ”„ ๐ŸŽช

Notifications You must be signed in to change notification settings

teamOpener/OpenOff-Client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

์˜คํ”„๋ผ์ธ ์ด๋ฒคํŠธ์˜ ์ƒˆ๋กœ์šด ์‹œ๋Œ€๋ฅผ ์—ด ์˜คํ”ˆ์˜คํ”„

โ€œ๋งค๋ฒˆ ๋‹ค๋ฅธ ํ”Œ๋žซํผ์œผ๋กœ ์˜ฎ๊ฒจ ๋‹ค๋‹ˆ๋Š” ๊ฑด ์ด์ œ ๊ทธ๋งŒ! ์˜คํ”„๋ผ์ธ ์ด๋ฒคํŠธ๋ฅผ ํƒ์ƒ‰ ํ˜น์€ ๊ฐœ์„คํ•˜๊ณ  ํ™๋ณด, ์‹ ์ฒญ, ์ฐธ์„ ์ธ์› ๊ด€๋ฆฌ๊นŒ์ง€ ํ•œ ๋ฒˆ์— ์ง„ํ–‰ํ•˜์„ธ์š”. โ€œ

Openoff

Go to changelog.md


๐ŸŽช Features

๐Ÿ‘€ ์˜คํ”„๋ผ์ธ ์ด๋ฒคํŠธ ์ถ”์ฒœ

๊ณต์—ฐ, ํŒŒํ‹ฐ, ์•กํ‹ฐ๋น„ํ‹ฐ ๋“ฑ ๊ด€์‹ฌ ๋ถ„์•ผ๋ณ„ ์˜คํ”„๋ผ์ธ ์ด๋ฒคํŠธ ์ •๋ณด๋ฅผ ํ•œ ๋ˆˆ์—!

14


๐Ÿ—บ๏ธ ์˜คํ”„๋ผ์ธ ์ด๋ฒคํŠธ ๋งต

์žฅ์†Œ๋ณ„ ์˜คํ”„๋ผ์ธ ์ด๋ฒคํŠธ ํ˜„ํ™ฉ์„ ์†์‰ฝ๊ฒŒ ํƒ์ƒ‰

15

16


๐ŸŽฏ ์˜คํ”„๋ผ์ธ ์ด๋ฒคํŠธ ์‹ ์ฒญ

์˜คํ”„๋ผ์ธ ์ด๋ฒคํŠธ ์‹ ์ฒญ ๋ฏธ๋ฆฌ ์ž…๋ ฅํ•œ ์ •๋ณด์˜ ์ž๋™ ์ž…๋ ฅ์„ ํ†ตํ•ด ํŽธ๋ฆฌํ•œ ์ด๋ฒคํŠธ ์‹ ์ฒญ

17

19

20


๐Ÿ“’ ์ด๋ฒคํŠธ ๊ฐœ์„ค ๋ฐ ๋ช…๋‹จ๊ด€๋ฆฌ

์˜คํ”„๋ผ์ธ ์ด๋ฒคํŠธ ๊ฐœ์„ค๋ถ€ํ„ฐ ์ด๋ฒคํŠธ ์‹ ์ฒญ ์Šน์ธ ํ˜„ํ™ฉ, ์ž…์žฅ ํ˜„ํ™ฉ ๋“ฑ์„ ํŒŒ์•… ๊ฐ€๋Šฅ
QR ์ฝ”๋“œ ์ž…์žฅ๊ถŒ ์Šค์บ” ๋ฐ ์ฐธ์„ ๋ช…๋‹จ ๊ด€๋ฆฌ๊นŒ์ง€ ํ•œ๋ฒˆ์—!

63

22

23

24


๐ŸŽช Tech Stacks

แ„‘แ…ณแ„…แ…ฉแ†ซแ„แ…ณแ„‹แ…ฆแ†ซแ„ƒแ…ณ แ„€แ…ตแ„‰แ…ฎแ†ฏแ„‰แ…ณแ„แ…ขแ†จ

๐ŸŽช Authors

์กฐ์—ฐ์ฃผ(Yeonju Jo) ํ™ฉํ˜ธ์„ธ(Jose Hwang)
QR์ฝ”๋“œ ์ธ์‹๊ธฐ๋Šฅ, ์•Œ๋ฆผ๊ธฐ๋Šฅ,
์ด๋ฒคํŠธ ๊ฐœ์„ค ๋ฐ ๋ช…๋‹จ๊ด€๋ฆฌ ํŽ˜์ด์ง€, ํ‹ฐ์ผ“ ํŽ˜์ด์ง€
ํšŒ์›๊ฐ€์ž… & ๋กœ๊ทธ์ธ, ๋ฉ”์ธํŽ˜์ด์ง€,
์ง€๋„ํŽ˜์ด์ง€, ๋งˆ์ดํŽ˜์ด์ง€
@yeonju0110 @JoStar33

๐ŸŽช How to Run the Project

  1. Clone this repository: git clone https://github.com/Central-MakeUs/OpenOff-Client.git
  2. Obtain the necessary environment files (located on the Notion page) and save them in the project directory:
    • .env
    • android/app/google-services.json
    • ios/GoogleService-Info.plist
  3. Install project dependencies: yarn
  4. Run the app on iOS or Android: yarn ios or yarn android

๐ŸŽช Build

Android

  1. Download the release-key.zip from the Notion page.
  2. Unzip the file and place it in the following directory: android/app/src.
  3. Enter additional code in the signingConfigs section within android/app/src/build.gradle.
  4. Update versionCode and versionName as needed.
  5. Initiate the build process.

iOS

  1. In the project settings, ensure that the Team is correctly set in OpenOff > Signing & Capabilities > Signing.
  2. Modify both the Version and Build as necessary.
  3. Navigate to Product > Archive to initiate the build process.

๐ŸŽช Folder Structure

๐Ÿ“ฆ OpenOff-Client
	โ”œโ”€ ...
	โ”œโ”€ android	// Android-specific project files.
	โ”œโ”€ ios		// iOS-specific project files.
	โ”œโ”€ src
	โ”‚  โ”œโ”€ apis/		// Responsible for fetching data from APIs.
	โ”‚  โ”œโ”€ assets/		// Static assets (images, fonts, etc.).
	โ”‚  โ”œโ”€ components/	// Reusable UI components.
	โ”‚  โ”œโ”€ constants/	// Constants used throughout the application.
	โ”‚  โ”œโ”€ hooks/		// Custom hooks and queries.
	โ”‚  โ”œโ”€ models/		// Data Transfer Object (DTO) type definitions.
	โ”‚  โ”œโ”€ navigators/	// Navigation-related code.
	โ”‚  โ”œโ”€ screens/		// React Native screens.
	โ”‚  โ”œโ”€ services/		// Integration with third-party services and APIs.
	โ”‚  โ”œโ”€ stores/		// State management using Async Storage and Zustand.
	โ”‚  โ”œโ”€ styles/		// Common styles.
	โ”‚  โ”œโ”€ types/		// Type definitions used by clients.
	โ”‚  โ”œโ”€ utils/		// Utility functions.
	โ”œโ”€ ...

๐ŸŽช Commit Convention

option content
โœจ feat ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€
๐Ÿ› fix ๋ฒ„๊ทธ๋ฅผ ๊ณ ์นœ ๊ฒฝ์šฐ
๐Ÿ“ docs ๋ฆฌ๋“œ๋ฏธ ์ˆ˜์ •
๐Ÿ’… design UI, UX ๊ด€๋ จ ์ฝ”๋“œ ์ˆ˜์ •
๐Ÿ’„ style ์ฝ”๋“œ format ์ˆ˜์ • (not production, UI,UX code)
๐Ÿซง refactor ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง ์ž‘์—…
๐Ÿ”ง chore ์ž‘์€ ๋ฒ”์œ„ ์ˆ˜์ • (ex. ์ฝ”๋ฉ˜ํŠธ, ์ฃผ์„)
๐Ÿšš move ํŒŒ์ผ ๋ฐ ํด๋” ์ด๋ฆ„ ๋ณ€๊ฒฝ
๐Ÿšš rename ํŒŒ์ผ ๋ฐ ํด๋” ์‚ญ์ œ
๐Ÿ‘ท ci CI/CD ๊ด€๋ จ ์ˆ˜์ •์‚ฌํ•ญ
๐Ÿšง wip ์ž‘์—…์ค‘์ธ ์‚ฌํ•ญ
โœ… test ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ๊ด€๋ จ

About

๐ŸŽช ์˜คํ”„๋ผ์ธ ์ด๋ฒคํŠธ์˜ ์ƒˆ๋กœ์šด ์‹œ๋Œ€๋ฅผ ์—ด ์˜คํ”ˆ;์˜คํ”„ ๐ŸŽช

Resources

Stars

Watchers

Forks