Skip to content

Commit

Permalink
chore: organise routing
Browse files Browse the repository at this point in the history
  • Loading branch information
ItsukiKigoshi committed Aug 8, 2024
1 parent 40df646 commit 725b4f5
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 54 deletions.
46 changes: 46 additions & 0 deletions docs/contribute/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
sidebar_position: 1
---

# Overview

:::note

This documents is under construction.
We need your support.
Click "Edit This Page" in the bottom to contribute to our docs.

:::

### Mission

- Enhance Liberal Arts in ICU by making academic planning easy

### Vision

- All the ICU students can deepen their academic career by comparing all the courses and planning the registration ahead.
- All the ICU students can actively participate in their academic process by visualising the academic path.

### Value

- **Open**: open-source, open-community
- anyone can submit feature request, content modification request easily (via GitHub?)
- Show reference of syllabus, requirements, and the rules of taking course (so that students can check the original data by themselves)
- Show updated date
- **Serendipity**: Ensuring the chance that students can come across other academic fields in the vast ocean of Liberal Arts.

### Motivation

-

### Members (Call for members)

- **[Itsuki Kigoshi](https://itsukikigoshi.github.io/)** ('27): Project Manager, Engineer (Mainly frontend)
- **Cao Yifei** ('27): Engineer (Mainly backend)
- and more!

:::info calling for new members!

Please join our [Discord](discord.gg/2gmKTs4ezk):fire: Just looking around Discord is fine:smile:

:::
5 changes: 0 additions & 5 deletions docs/contribute/intro.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/contribute/specification/frontend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Frontend
Original file line number Diff line number Diff line change
Expand Up @@ -4,50 +4,9 @@ sidebar_position: 2

# Specification

:::note
## Features

This documents is under construction.
We need your support.
Click "Edit This Page" in the bottom to contribute to our docs.

:::

### Mission

- Enhance Liberal Arts in ICU by making academic planning easy

### Vision

- All the ICU students can deepen their academic career by comparing all the courses and planning the registration ahead.
- All the ICU students can actively participate in their academic process by visualising the academic path.

### Value

- **Open**: open-source, open-community
- anyone can submit feature request, content modification request easily (via GitHub?)
- Show reference of syllabus, requirements, and the rules of taking course (so that students can check the original data by themselves)
- Show updated date
- **Serendipity**: Ensuring the chance that students can come across other academic fields in the vast ocean of Liberal Arts.

### Motivation

-

### Members (Call for members)

- **[Itsuki Kigoshi](https://itsukikigoshi.github.io/)** ('27): Project Manager, Engineer (Mainly frontend)
- **Cao Yifei** ('27): Engineer (Mainly backend)
- and more!

:::info calling for new members!

Please join our [Discord](discord.gg/2gmKTs4ezk):fire: Just looking around Discord is fine:smile:

:::

### Features

#### First Priority (v1.0.0?)
### First Priority (v1.0.0?)

1. **Search:** Syllabus search feature
1. Scraped from [Course Offerings](https://campus.icu.ac.jp/icumap/ehb/SearchCO.aspx)
Expand All @@ -62,7 +21,7 @@ Please join our [Discord](discord.gg/2gmKTs4ezk):fire: Just looking around Disco
1. Calculate the sum of units
2. Can compare multiple courses

#### Second Priority
### Second Priority

1. **Course Recommendation**: Course recommendation system based on the user data with privacy security
2. **Integrated curriculum tree**: (pre-required course list, interactive curriculum tree)
Expand All @@ -77,20 +36,20 @@ Please join our [Discord](discord.gg/2gmKTs4ezk):fire: Just looking around Disco
9. **Export to Google Calendar**
10. [We will receive ideas for additional features via ましゅまろ or other social media from all the ICU students!! (after releasing v1.0.0)]

### Routing
## Routing

#### App
### App

- https://www.catalogue.icu
- repo: https://github.com/ItsukiKigoshi/icu-catalogue

#### API
### API

- https://api.catalogue.icu (not yet deployed)
- repo: https://github.com/ItsukiKigoshi/icu-catalogue-api
- API Docs: https://api.catalogue.icu/docs (not yet deployed)

#### Docs
### Docs

- https://docs.catalogue.icu
- repo: https://github.com/ItsukiKigoshi/icu-catalogue-docs
2 changes: 1 addition & 1 deletion src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ function HomepageHeader() {
<div className={styles.buttons}>
<Link
className="button button--secondary button--lg"
to="/docs/contribute/specification"
to="/docs/contribute/"
>
Go to Docs
</Link>
Expand Down

0 comments on commit 725b4f5

Please sign in to comment.