From 304be7e2c24bb142867c6f1c94952dcd05633480 Mon Sep 17 00:00:00 2001 From: kangbeomjoon Date: Sun, 10 Nov 2024 22:29:36 +0900 Subject: [PATCH] started mission11 --- README.md | 55 ++++++++++++++++++++++--------------------------------- 1 file changed, 22 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index a7d119aaf..481327f13 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,29 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +# **요구사항** -## Getting Started +## **기본 요구사항** -First, run the development server: +**공통** -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` +- [x] Github에 위클리 미션 PR을 만들어 주세요. +- [x] React 및 Express를 사용해 진행합니다. +- [x] TypeScript를 활용해 프로젝트의 필요한 곳에 타입을 명시해 주세요. +- [x] `any` 타입의 사용은 최소화해 주세요. +- [x] 복잡한 객체 구조나 배열 구조를 가진 변수에 인터페이스 또는 타입 별칭을 사용하세요. +- [ ] Union, Intersection, Generics 등 고급 타입을 적극적으로 사용해 주세요. +- [ ] 타입 별칭 또는 유틸리티 타입을 사용해 타입 복잡성을 줄여주세요. +- [x] 타입스크립트 컴파일러가 에러 없이 정상적으로 작동해야 합니다. -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +**프론트엔드** -You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file. +- [ ] 기존 React(혹은 Next) 프로젝트를 타입스크립트 프로젝트로 마이그레이션 해주세요. +- [ ] TypeScript를 활용해 프로젝트의 필요한 곳에 타입을 명시해 주세요. -[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`. +**백엔드** -The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. - -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! - -## Deploy on Vercel - -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for m +- [ ] 기존 Express.js 프로젝트를 타입스크립트 프로젝트로 마이그레이션 해주세요. +- [ ] [ ] `tsconfig.json` 파일을 생성하고, 필요한 컴파일러 옵션을 설정해야 합니다. (예: `outDir`). +- [ ] TypeScript 관련 명령어를 `package.json`에 설정해 주세요. (예: 빌드 및 개발 서버 실행 명령어). +- [ ] [ ] `ts-node`와 `nodemon`을 사용하여 개발 환경을 구성합니다. + - [ ] [ ] `nodemon`과 함께 `ts-node`를 사용하여 `. ts` 파일이 변경될 때 서버를 자동으로 재시작하도록 설정합니다. +- [ ] Mongoose나 Prisma 등 ORM을 사용하는 경우, 모델에 대한 인터페이스 또는 타입을 정의합니다. +- [ ] 필요한 경우, `declare`를 사용하여 타입을 오버라이드하거나 확장합니다.