Skip to content
This repository has been archived by the owner on Jan 24, 2025. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Hank-Choi authored Jan 24, 2025
1 parent 3bc6bd6 commit c07331d
Showing 1 changed file with 4 additions and 37 deletions.
41 changes: 4 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,6 @@
# snutt
SNU Timetable API 서버
# ⚠️ Deprecated: snutt-nodejs

서울대학교 수강편람 검색 및 시간표 관리를 위한 애플리케이션입니다.
> **이 프로젝트는 더 이상 유지보수되지 않습니다.**
## Related Repositories
- [snutt-timetable](https://github.com/wafflestudio/snutt-timetable) : snutt 를 대체할 Spring WebFlux 시간표 서비스 서버 (migration 진행 중)
- [snutt-ev](https://github.com/wafflestudio/snutt-ev) : 강의평 서비스 서버

## Contributing
PR is welcome!

## Framework
본 프로젝트는 REST API 서버로서 별도의 프론트엔드 클라이언트가 필요합니다. 기기 알림과 페이스북 로그인을 지원하며, 이를 위해서는 구글 Firebase와 Facebook 프로젝트를 별도로 설정해야 합니다. MongoDB를 데이터베이스로 사용합니다. Redis DB를 캐시 저장소로 사용합니다.

## Requirements
* Linux (CentOS, Ubuntu, Arch, etc.)
* Node.js 8.15.0
* MongoDB 3.6.9
* Redis 4.0.12

## Documentation
- [깃헙 위키](https://github.com/wafflestudio/snutt/wiki/Deploying-2.0.0)
- [Notion](https://www.notion.so/SNUTT-f5c63e408e2c4275af4682112abd6af7)
- [Feedback](https://github.com/wafflestudio/snutt-feedbacks/)

## Front-end Clients
* [Web Client](https://github.com/wafflestudio/snutt-webclient/)
* [Android Client](https://github.com/wafflestudio/SNUTT-android)
* [iOS Client](https://github.com/wafflestudio/SNUTT-iOS)

## Liability
SNUTT는 [서울대학교 수강편람 서비스](http://sugang.snu.ac.kr)에서 데이터를 다운로드 후 가공합니다. 잦은 크롤링을 수행하면, 서울대학교 측으로부터 IP 밴 등의 불이익이 있을 수 있습니다. 와플스튜디오는 데이터 크롤링에 수반하는 일체의 불이익에 대하여 책임지지 않으며, 본 프로그램을 사용하는 경우 서울대학교 서비스에 부하를 가하기 않도록 유의하여야 합니다.

## 다른 학교에서도 이용할 수 있나요?
본 프로젝트는 MIT 라이센스로 공개되어 있으므로, 열정과 시간이 있으시다면 다른 학교의 상황에 맞게 수정하실 수 있습니다.

## License
MIT
`snutt-nodejs` 프로젝트는 현재 **Kotlin Spring** 기반으로 새롭게 개발된 [`snutt`](https://github.com/snutt) 프로젝트로 대체되었습니다.
이전 코드베이스는 참고용으로만 제공되며, 새로운 기능 개발 및 유지보수는 진행되지 않습니다.

0 comments on commit c07331d

Please sign in to comment.