The CSU Navigation
Because of the stupid design of the school official site, I would like to create a navigation for school websites and other common websites.
- Create the Basic Layout
- Support the Mobile Devices
- Deploy on GitHub Pages
- Add Loading Cat Animation
- Design the Logo
- Add Analytics for the Clicks
- Add About Page
- Add Broken Link List for School Pages
- Add Issues, Feedback and Contact
- Allow Users to Change the Background
- Add Detailed Introduction for Each Link
- Beautify the Layout
- Add Dark Mode Support
- Allow Users to Change the Layout through Dragging
- Add E-guide for Newcomers
- Add Icons for Links
-
Global Language Support - Deploy on Individual Domain and Server
- Add Search Function(Maybe)
If you are a student of CSU, just open the official site.
If you want to create a navigation for your own school, just fork this project and change the " /url-process/origin-urls.json" file, then the python script should be run automatically by GitHub Actions to generate the ts file.After that, the page will be deployed on GitHub Pages.
-
Install Node.js
-
Change source to Chinese-mirror
npm config set registry https://registry.npm.taobao.org -
If you're using VS Code, Vue-Official-Plugin would be a good choice
-
Clone the project
git clone https://github.com/Temparo/csu-index
-
Install pnpm
npm install -g pnpm
-
Download the dependencies
pnpm install
-
Start the project
pnpm dev
-
Browse to http://localhost:5173 and start contributing !
- Contributing is welcome, just fork the project and create a pull request.
- Make your changes on dev branch, Rather than main
- If you have any questions or suggestions, feel free to open an issue.
- The Project is created by Vue 3 + TypeScript
- This project is inspired by ZJUers轻首页
- Some idea of functions is from BYR-Navi
- The Loading Cat animation is by TouNeko
- The dark mode toggle button is by MarvinRudolph
- The title style imitates YesIcon
- Myself!!!(๑¯ω¯๑)
This project is under Apache-2.0 License.