-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #356 from senior-knights/fix/documentation
Documentation cleanup and deployment test
- Loading branch information
Showing
8 changed files
with
8,589 additions
and
6,843 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,90 +1,47 @@ | ||
| # <p align="center"><img src="./CourseSchedulizerMediaFinal.png" alt="Course Schedulizer" title="Course Schedulizer"/></p> | ||
|
|
||
| 📝 **Create semester schedules without stress.** This is the monorepository for the [`senior-knights/course-schedulizer`](https://github.com/senior-knights/course-schedulizer) project. For more information about the application, please view the [About Page](https://senior-knights.github.io/course-schedulizer/#/about) on our website. For help using the application, visit our [Help Page](https://senior-knights.github.io/course-schedulizer/#/help) (once we make it). | ||
|
|
||
| <a href="https://senior-knights.github.io/course-schedulizer/"><img alt="prod build" src="https://img.shields.io/badge/schedulizer-8C2131?logo=internet-explorer" /></a> | ||
| <a href="https://github.com/senior-knights/course-schedulizer"><img src="https://img.shields.io/github/workflow/status/senior-knights/course-schedulizer/Deployment.svg" alt="deployment status"></a> | ||
| <a href="https://www.calvin.edu"><img alt="https://senior-knights.github.io/course-schedulizer/" src="https://img.shields.io/badge/calvin-knights-F3CD00?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAMAAAAolt3jAAAB8lBMVEUAAAB4eHgZUUa+lp2ShYdOT1EvLS7/2ewfHh4oJif///9ISU8uLCzQwpcICAUxLzBGREU7OTpxbm5tbGsACgZvbm0rXlRRT1BSUFD//9IeHiBTUVF1dHJXamRoZmUBBDC3spvw26AJCQxFTnBubW4CBTS/t5r//8IVFht/gYCacniaWWOqeICvlZp9cnQAAAB1c3OgjI+dZW+ZPk6cgYd9fn6ri5DCrYkpOVcuLCxPT0+Be3yZWGTryWmhl30hICCAfn+ylZm5nXgAAENWVVWhl5mkhY3ewX2yholxc3QAAAAAAEHIsXGxhoxzdHMYWktUZGmQjILszHWzlXoAAD5JTk2XhYiqfH6teHvNlnSjl39ESkmci4/Rq3/FrYhxcm8WPlGdmILUunH2ylLTu3ZRWnVtcYG5qX7pxF3rwmCqn34AF2SZk4TUuG7XumxeZn9xc320poOimIGeRFSgR1K7gIiYOEmpVlXkuIXwyX/wxnSlTVLu0KL/+Nz//e//7rOhTl3Tn4P//Or9+/rv2sTZqIHPkFz22aHJmJ+7en+7fIe7e4btw3W9gIy5eoW+g429gIrz05rfwL3LnajFh3D0w1z/3nn/773u0Y7uuVbIhFytX2HGhGTntmzOmHznr1O0Z1ieRFXTl2L5x0nlrlr3ykssme+IAAAAc3RSTlMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACax+vrLLAJBfcz+hDrYvw0DCjTc808NgeSiAzOgrOrcHQIFnt4eAQ9j+Z8DEXfN6/5wDoLuzCIDQ8L9vg8WhOz6XgNEwsgUG5lvA/jZ2AAAAI1JREFUCNc9y8FHQwEAx/Hf5xIREzNj0mGKmTEdslT2GJP+3yfR28syKdJhpEP/RsQuO7yt48fXV4Rz8GUjBwMoqNf+5NBQAZX1r6MRprDwSWu8E08+HLtoVirvkvblP18lnavdXXuR7i3cYFmTXtGAZ5XkZLavHiU5NefaygNJkv4dkzflT8Ocuaf0vQXX3B/iTs/DcAAAAABJRU5ErkJggg==" /></a> | ||
| <a href="https://sharp-babbage-a45ee2.netlify.app/"><img alt="dev build" src="https://img.shields.io/badge/schedulizer%20dev-71B1C8?logo=internet-explorer" /></a> | ||
|
|
||
| > Created by current students at [Calvin University](https://calvin.edu/) for their [computer science senior project](https://cs.calvin.edu/courses/cs/396/). | ||
| > Find DOCUMENTATION at our [documentation page](https://docs.google.com/document/d/1lzlC1wNSYjhr5y5d4IxUpMyLuw5_kaxHmdN8W6C4j00/edit?usp=sharing). | ||
| ## Built with | ||
|
|
||
| <a href="https://reactjs.org/"><img alt="https://senior-knights.github.io/course-schedulizer/" src="https://img.shields.io/badge/react-000?logo=react" /></a> | ||
| <a href="https://www.typescriptlang.org/"><img alt="https://senior-knights.github.io/course-schedulizer/" src="https://img.shields.io/badge/typescript-000?logo=typescript" /><a/> | ||
| <a href="https://code.visualstudio.com/"><img alt="https://senior-knights.github.io/course-schedulizer/" src="https://img.shields.io/badge/VS Code-000?logo=visual%20studio%20code" /></a> | ||
| <a href="https://github.com/"><img alt="https://senior-knights.github.io/course-schedulizer/" src="https://img.shields.io/badge/github-000?logo=github" /></a> | ||
| <a href="https://www.npmjs.com/"><img alt="https://senior-knights.github.io/course-schedulizer/" src="https://img.shields.io/badge/npm-000?logo=npm" /></a> | ||
| <a href="https://www.netlify.com/"><img alt="https://senior-knights.github.io/course-schedulizer/" src="https://img.shields.io/badge/netlify-000?logo=netlify" /></a> | ||
|
|
||
| ## Background | ||
|
|
||
| Every year, all department chairs at Calvin must develop a schedule for their department’s classes based on a spreadsheet provided to them by the Registrar. The schedule must contain the times, professors, and rooms for every class section in the department and the schedule must satisfy many constraints, for example: only one section can be in a room at a time, a professor can only teach one section at a time, among others. These constraints make it extremely difficult for the department chair to create a schedule without a tool to help them. We propose building a web application, named the Course Schedulizer, that will allow department chairs to visualize and manipulate their department course schedules. It will provide: the ability to upload and export department schedules via CSV, integration with the spreadsheets provided and required by the Registrar, two views to visualize the schedule data (by location and by instructor), schedule conflict detection and resolution suggestions (for the honors portion), and many other features. | ||
|
|
||
| For more information, please visit the [About Page](https://senior-knights.github.io/course-schedulizer/#/about). | ||
|
|
||
| ## How to use | ||
|
|
||
| Detailed information can be found on our [Help Page](https://senior-knights.github.io/course-schedulizer/#/help) (once we make it). Access our production website and upload a CSV following the prescribed specifications (items marked with * are optional and ignored, but were required in older versions of the app) | ||
|
|
||
| - Department: string (like `Mathematics`) | ||
| - *Term: [0-9][0-9]/(FA | SP | IN) (like `21/SP` for Spring 2021) | ||
| - TermStart: mm/dd/yyyy (like `3/29/2021` or `12/1/2022`) | ||
| - *AcademicYear: yyyy (like `2021`) | ||
| - *SectionName: SubjectCode-CourseNum-SectionCode (like `MATH-252-B`) | ||
| - SubjectCode: string (like `MATH`) | ||
| - CourseNum: string (like `252` or `252L` for a lab) | ||
| - SectionCode: string (like `B`) | ||
| - CourseLevelCode: pos num (like `200` for a 200 level course) | ||
| - MinimumCredits: pos num (like `3` or `3.5`) | ||
| - FacultyLoad: pos num (like `4` or `4.5`) | ||
| - *Used: pos num (like `20`) | ||
| - *Day10Used: pos num (like `22`) | ||
| - *LocalMax: pos num (like `25`) | ||
| - *GlobalMax: pos num (like `30`) | ||
| - *RoomCapacity: pos num (like `32`) | ||
| - BuildingAndRoom: string (like `HH 345`) | ||
| - MeetingDays: M?T?W?(TH)?F? (like `MWTHF`) | ||
| - MeetingTime: xx:xx(AM | PM) - xx:xx(AM | PM) (like `9:00AM - 9:50AM`) | ||
| - SectionStartDate: mm/dd/yyyy (like `3/29/2021` or `12/1/2022`) | ||
| - SectionEndDate: mm/dd/yyyy (like `3/29/2021` or `12/1/2022`) | ||
| - *Building: string (like `HH`) | ||
| - *RoomNumber: string (like `345`) | ||
| - MeetingStart: xx:xx(AM | PM) (like `2:30PM`) | ||
| - *MeetingStartInternal: xx:xx:xx 24-hour (like `14:30:00`) | ||
| - MeetingEnd: xx:xx(AM | PM) (like `3:20PM`) | ||
| - *MeetingEndInternal: xx:xx:xx 24-hour (like `13:20:00`) | ||
| - *Monday: `M` or empty | ||
| - *Tuesday: `T` or empty | ||
| - *Wednesday: `W` or empty | ||
| - *Thursday: `TH` or empty | ||
| - *Friday: `F` or empty | ||
| - ShortTitle: string (like `Number Theory`) | ||
| - Faculty: string (first and last) (like `Paul Erdos`) | ||
| - *SectionStatus: string (like `Active`) | ||
| - InstructionalMethod: `LEC`, `CPI`, `IND`, `TUT`, or `SEM` | ||
| - DeliveryMode: `In-person`, `Online (synchronous)`, `Online (asynchronous)`, `Hybrid` | ||
| <p align="center"><img src="./CourseSchedulizerMediaFinal.png" alt="Course Schedulizer" title="Course Schedulizer"/></p> | ||
|
|
||
| ## Development | ||
| [](https://www.calvin.edu) | ||
| [](https://computing.calvin.edu) | ||
| [](https://senior-knights.github.io/course-schedulizer/) | ||
| [](https://github.com/senior-knights/course-schedulizer) | ||
| [](https://sharp-babbage-a45ee2.netlify.app/) | ||
| [](https://github.com/senior-knights/course-schedulizer) | ||
| [](https://github.com/senior-knights/course-schedulizer) | ||
| [](https://github.com/senior-knights/course-schedulizer) | ||
|
|
||
| ### Basic Introduction | ||
| _Create academic course schedules without stress._ | ||
|
|
||
| This is a mono repository for the Course Schedulizer project. It is best used with [VS Code](https://code.visualstudio.com/). To begin editing, open the [workspace file](.vscode/course-schedulizer.code-workspace), located in `.vscode/`, with VS Code. Opening the workspace in VS Code will prompt to install extensions; please do so. | ||
| This is the repository for the Course Schedulizer project created by students at [Calvin University](https://calvin.edu/) for the [Computer Science senior project](https://cs.calvin.edu/courses/cs/396/). For more information, see the: | ||
|
|
||
| This provides information about the root repository, for the client app information, please view the [`client-course-schedulizer/README.md`](./client-course-schedulizer/README.md). | ||
| - [About page](https://senior-knights.github.io/course-schedulizer/#/about) for a discussion of the purpose of the application. | ||
| - [Help page](https://senior-knights.github.io/course-schedulizer/#/help) for instructions on how to use the application. | ||
| - [Client README file](client-course-schedulizer/README.md) for a specification of the system development workflow. | ||
|
|
||
| ### Development Philosophy | ||
| ## Development Philosophy | ||
|
|
||
| `production` branch is a persistent branch that contains the most stable version of the Course Schedulizer. It requires two reviews to merge PRs to this branch. | ||
| We generally follow the [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) collaboration model, with production, development, and feature branches. | ||
|
|
||
| `develop` branch is a persistent branch that contains the cutting edge version of the Course Schedulizer. It requires one review to merge PRs to this branch. Each PR is ideally around 100-200 LOC. | ||
| - The `production` branch is a persistent branch that contains the most stable version of the Course Schedulizer. It requires two reviews to merge PRs to this branch. | ||
| - The `develop` branch is a persistent branch that contains the cutting edge version of the Course Schedulizer. It requires one review to merge PRs to this branch. Each PR is ideally around 100-200 LOC. | ||
| - Feature branches are cloned from `develop` and are used for developing new features. They are merged back into `develop` when the feature is complete. | ||
|
|
||
| Code reviews are done on every PR merged into the two persistent branches. A PR is made with a branch following the naming convention of `<broad>/<specific>`. `<broad>` are things like `feature`, `docs`, `chore`, `fix`, etc. | ||
|
|
||
| ### Repository Configuration | ||
| ## Repository Configuration | ||
|
|
||
| The repo is a [mono-repository](https://en.wikipedia.org/wiki/Monorepo), to spite the fact that it comprises only one application, stored in `./client-course-schedulizer`. This historical artifact leaves open the possibility of adding applications in the future. | ||
|
|
||
| Because the application is open source, we use free minutes of GitHub actions to perform CI/CD. `ci.yml` tests on any push or PR against `develop` or `production`. | ||
|
|
||
| `.vscode/` contains the directory settings. It most notably uses Prettier to format code on save. Formatting will fix ESLint issues, organize imports, and then fix Editor Config and Prettier issues. `.editorconfig` and `.prettierrc.js` are located in the root, and `.eslint.js` is specific to each application. For example, the client config is located inside the client folder. | ||
| ## Development | ||
|
|
||
| To work with this GitHub codebase, `git clone` this repo and `cd` into the new repo sub-directory. | ||
|
|
||
| Development is best done using [VS Code](https://code.visualstudio.com/) and the pre-defined project [workspace](https://code.visualstudio.com/docs/editor/workspaces). To begin editing, open the [workspace file](.vscode/course-schedulizer.code-workspace) with VS Code. This will configure VS Code [settings](https://code.visualstudio.com/docs/getstarted/settings) and prompt you to install the recommended VS Code [extensions](https://code.visualstudio.com/docs/editor/extension-marketplace), which helps maintain the consistency and quality of the project codebase. The extensions include: | ||
|
|
||
| - [EditorConfig](https://editorconfig.org/), which specifies shared editor configuration parameters (see [`.editorconfig`](.editorconfig)). | ||
| - [Prettier](https://prettier.io/), which formats code and organizes imports (see [`.prettierrc.js`](.prettierrc.js)). | ||
| - [ESLint](https://eslint.org/), which specifies application-specific formatting rules (see [`client-course-schedulizer/.eslintrc.js`](client-course-schedulizer/.eslintrc.js)). | ||
| - [CSpell](https://cspell.org/), which checks spelling in markdown, comments, and strings (see the `cspell` settings in [`.vscode/course-schedulizer.code-workspace`](.vscode/course-schedulizer.code-workspace)). | ||
|
|
||
| You can add your own user-specific VS Code extensions, but be sure to use these recommended, shared settings and extensions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| use-node-version=20.15.1 |
Oops, something went wrong.