About this project
# NTUST Freshman Guide (freshman)
The "NTUST Freshman Guide" is an open-source freshman guide jointly maintained by students of National Taiwan University of Science and Technology (NTUST). The project aims to systematically organize common confusions and problems freshmen encounter in course selection, housing, daily life, etc., and allows everyone to contribute and correct content through open-source methods.
## Main Content
The guide covers the following four major aspects:
* **Course Selection**: From understanding proper nouns to practical skills.
* **Life**: Includes information on housing, dining, transportation, and clubs.
* **Information**: Campus account usage, payment processes, recommended useful tools, and community links.
* **Others**: Freshman Frequently Asked Questions (FAQ) and NTUST trivia.
## Key Features
* **Department-Specific Content**: The website can display advice and information from direct seniors based on the department selected by the user.
* **Academic Year Calendar**: Automatically synchronizes and displays the academic year calendar taken from official announcements.
* **Open Contribution**: All article content is in pure Markdown files. Contributors can directly correct typos or supplement content via the GitHub web interface, lowering the barrier to contribution.
## Technical Architecture
* **Framework**: Uses Astro 7 for Static Site Generation (SSG).
* **Content Management**: Adopts Markdown combined with content collections and zod strict schema for structured management.
* **Deployment**: Hosted on Cloudflare Pages.
* **Syntax Extensions**: Supports special Markdown syntax through custom remark-directive and serializer.
## Development and Contribution
The project requires a Node.js environment version 22.12 or above. Contributors must follow the Conventional Commits specification and name branches with `feat/` or `fix/` prefixes. Content modifications must include sources or personal experience, and annual data (such as amounts, rates) must indicate the verification date. UI copy and content use Traditional Chinese, while code comments use English.
## License and Disclaimer
This project is licensed under the GNU Affero General Public License v3.0. It is important to note that this project has no official association with National Taiwan University of Science and Technology. The content is organized by students based on experience; actual regulations, amounts, and schedules are subject to official announcements.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.