Skip to content

[22-23 GDSC TUK 1기] 2분기 리액트 스터디를 위한 저장소 - 포켓몬 도감 만들기

Notifications You must be signed in to change notification settings

jqkk/2023-01-React-Study-Pokedex

 
 

Repository files navigation

프로젝트 주제

  • 포켓몬 도감 만들기

개요

  • Pokemon API를 활용하여 포켓몬 도감을 만듭니다.
  • pokedex의 UI를 디자인 시안 삼아 구현하도록 합니다.

실행 방법

  • node js가 설치가 선행되어야 합니다.(v16.14.1)

  • 만약 yarn이 설치되어 있지 않은 경우, 아래의 명령어로 yarn을 설치합니다.

npm i -g yarn
  • 아래 명령어로 실행시킬 수 있습니다.
yarn && yarn dev

URL

기술 스택

- typescript
- react 18
- react-router-dom v6
- react-query
- react-intersection-observer
- jotai
- framer-motion
- twin-macro
- yarn
- husky
- vite
- storybook

폴더 구조

.
└── src
    ├── App.tsx
    ├── Router.tsx
    ├── components
    │   ├── ImageView.stories.ts
    │   ├── ImageView.tsx
    │   ├── Navigation.stories.ts
    │   ├── Navigation.tsx
    │   ├── buttons
    │   │   ├── Button.stories.tsx
    │   │   ├── Button.tsx
    │   │   ├── NextButton.tsx
    │   │   ├── PreviousButton.tsx
    │   │   └── index.ts
    │   ├── icons
    │   │   ├── BackgroundIcon.tsx
    │   │   ├── NextIcon.tsx
    │   │   ├── PreviousIcon.tsx
    │   │   └── index.ts
    │   └── index.ts
    ├── domains
    │   ├── api
    │   │   ├── index.ts
    │   │   └── pokemon.ts
    │   ├── atoms
    │   │   ├── HydrateAtoms.tsx
    │   │   ├── color-palette.ts
    │   │   └── count.ts
    │   ├── components
    │   │   ├── Card.stories.tsx
    │   │   ├── Card.tsx
    │   │   ├── background
    │   │   │   ├── Background.stories.tsx
    │   │   │   ├── Background.tsx
    │   │   │   └── index.ts
    │   │   ├── index.ts
    │   │   ├── pokedex-evolution-chain
    │   │   │   ├── PokedexEvolutionChain.stories.tsx
    │   │   │   ├── PokedexEvolutionChain.tsx
    │   │   │   └── index.ts
    │   │   ├── pokedex-header
    │   │   │   ├── PokedexHeader.stories.tsx
    │   │   │   ├── PokedexHeader.tsx
    │   │   │   └── index.ts
    │   │   ├── pokedex-list
    │   │   │   ├── PokedexItem.stories.tsx
    │   │   │   ├── PokedexItem.tsx
    │   │   │   └── PokedexList.tsx
    │   │   ├── pokedex-picture
    │   │   │   ├── PokedexPicture.stories.tsx
    │   │   │   ├── PokedexPicture.tsx
    │   │   │   └── index.ts
    │   │   ├── pokedex-stats
    │   │   │   ├── PokedexStats.stories.tsx
    │   │   │   ├── PokedexStats.tsx
    │   │   │   └── index.ts
    │   │   └── pokedex-type
    │   │       ├── PokedexType.stories.tsx
    │   │       ├── PokedexType.tsx
    │   │       └── index.ts
    │   ├── hooks
    │   │   ├── index.ts
    │   │   ├── queries
    │   │   │   ├── useGetPokemonInfoQueries.ts
    │   │   │   ├── useGetPokemonListQuery.ts
    │   │   │   └── useGetPokemonStatsQuery.ts
    │   │   ├── useBackgroundColor.ts
    │   │   └── useNavigation.ts
    │   ├── types
    │   │   ├── index.ts
    │   │   └── pokemon.ts
    │   └── utils
    │       ├── color.ts
    │       ├── fns.ts
    │       └── index.ts
    ├── main.tsx
    ├── motions
    │   ├── image-view.motion.ts
    │   └── index.ts
    ├── pages
    │   ├── PokedexDetailPage.tsx
    │   ├── PokedexListPage.tsx
    │   └── index.ts
    └── styles
        └── GlobalStyles.tsx

회고

1주차 회고
2주차 회고
3주차 회고

프로젝트 진행 방식

  • 해당 레포지토리를 자신의 레포지토리로 fork 받은 후, 구현을 진행합니다.
  • 기술 스택은 자유롭게 선정하여 진행합니다.
  • 매주 정기 회의(목요일 밤 10시) 전까지 구현 결과물을 해당 레포지토리의 자신의 이름으로 된 브랜치로 Pull Request를 날리도록 합니다.
    • ex) jqkk/2023-01-React-Study-Pokedex의 main 브랜치에서 Google-Developer-Student-Clubs-TUK /2023-01-React-Study-Pokedex의 jqkk 브랜치로 Pull Request를 날립니다.
  • 정기 회의 전까지 구현한 프로젝트를 github-pages, vercel 등을 활용하여 배포하도록 합니다.
  • 리드미의 실행 방법, URL, 기술 스택, 폴더 구조 항목에 대해서는 정기 회의 전 각자 작성하도록 합니다.
    • 이외에 리드미에 추가하고 싶은 항목이 있다면 자유롭게 추가하시면 됩니다.

참고 링크

About

[22-23 GDSC TUK 1기] 2분기 리액트 스터디를 위한 저장소 - 포켓몬 도감 만들기

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 91.8%
  • JavaScript 6.7%
  • HTML 1.3%
  • Shell 0.2%