Skip to content

chillcicada/CcThu

Repository files navigation

CcThu

Warning

🚧🚧 WIP now! 🚧🚧

GitHub Actions Workflow Status wakatime GitHub License

Introduction

CcThu is an API server based on Bun and Elysia that helps users build their own THU API server quickly.

Features

We have currently implemented event-driven module lazy loading, and combined with the performance of Bun and Elysia, we are able to maintain resource usage under 100 MB in scenarios with hundreds of thousands of requests per second (local tests show around 75 MB, which is more than sufficient in fact). This makes it highly suitable for deployment on personal edge computing devices. In principle, it can handle the normal requests of all the teachers, students, and staff in a school, but we still recommend private deployment and do not advocate for or provide public interfaces.

Unsupported Websites / Interfaces

[!WARNING] We won't provide any support for interfaces that are prone to be easily abused.

e.g.:

  • lib.tsinghua.edu.cn / 图书馆阅读相关接口
  • ...

If you privately implement relevant interfaces and cause abuse and are punished, you are responsible for the consequences and we have nothing to do with the responsibility. The right of interpretation belongs to us.

Usage

Warning

The project is still under development, so there is no release yet. And it is not recommended to use it now.

Documentation

In coming.

Deployment

In coming.

Development

See CONTRIBUTING.md.

Insight

CcThu

Q&A

Some questions you may have.
  • Q: How does this API server work?

    A: Use cookies and to simulate login, and then use the request to get the data, and finally parse the data on server and return it to the user. We manually maintain the cookie mechanisms.

  • Q: What is the frequency of updates/commits?

    A: Every Friday evening (UTC+8). Exculding some special cases.

  • Q: What's the development plan?

    A: I'm currently working for the releasing of version 0.1.0. Learn more at here. For I'm very busy 😎, I may only focus on key parts of the development before v0.1.0. It's due to released in the August and September of this year.

Acknowledgment

License

GPL-3.0

About

An API server for THU. WIP now 🚧🚧.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published