diff --git a/README.md b/README.md index da8d02a..00d36bb 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,32 @@ -# Welcome to Remix! +# KOJ 3.0 - Client -- [Remix Docs](https://remix.run/docs) +본 프로젝트는 경북대학교 소프트웨어 공학 연구실에서 제작된 프로그래밍 실습 과목 채점 시스템의 클라이언트 파트입니다. -## Development +# 실행 방법 -From your terminal: +`npm run build`후 `npm run start`로 실행 가능. -```sh -npm run dev -``` +# 사용한 기술스택 -This starts your app in development mode, rebuilding assets on file changes. +- Remix +- Typescript +- css modules +- -## Deployment +# 폴더 구조 -First, build your app for production: +`app/API` : API 유틸 함수 -```sh -npm run build -``` +`app/assets` : 다양한 곳에 사용되는 애셋(특히 이미지) -Then run the app in production mode: +`app/contexts` : 여러 컴포넌트에서 전역으로 쓰이는 정보를 저장하는 React Context -```sh -npm start -``` +`app/css` : 전역 css -Now you'll need to pick a host to deploy it to. +`app/routes ` : [remix-flat-routes](https://github.com/kiliman/remix-flat-routes)를 활용한 실제로 라우팅 되는 page 컴포넌트 -### DIY +`app/types` : 대부분 API에서 오는 타입들을 정리해둔 폴더 -If you're familiar with deploying node applications, the built-in Remix app server is production-ready. +`app/util` : 여러곳에 쓰여서 코드 중복이 발생하거나, 외부라이브러리에 너무 적극적으로 의존해서 렌더링 로직에 넣기 뭣한 것들 -Make sure to deploy the output of `remix build` - -- `build/` -- `public/build/` +`public` : 전역으로 필요한 폰트, og:image, 빈칸 코드 렌더링 보조를 위한 prism.js, 학생 등록을 위해 필요한 엑셀 파일