This syllabus bank and its web infrastructure are an initiative by the Hunter College Open Source Club. The syllabi were generously provided by a number of students listed in the Contributors section below.
The currently supported departments are:
See the How can I help? section to learn more about what you can do to help keep this project alive.
Contents:
- Add new syllabi
- Add missing faculty mugshots
- Add a new department
- Add new features to the website
- Provide feedback and suggest improvements
- Advocate for things that will help this project
We are happy to accept your changes in whatever format you are comfortable providing them. If you would like to try your hand at submitting a pull request with your change, you may find this freeCodeCamp tutorial helpful. Alternatively, you could open an issue, or send us an email at our open.source.club.hunter@gmail.com address. Some of the instructions below detail steps on a technical level, but remember that you can also talk to us informally at the venues we've mentioned above.
NOTE: To preview the website locally with your code changes applied, you can follow the instructions in the Building the website locally section.
NOTE: We only support PDF files at this time. If you would like to share a URL to a course page, please file an issue.
In order to upload a new syllabus:
- Ensure your PDF's file name is in the canonical format:
<course code>_<professor>_syllabus_<semester>.pdf- For example,
CS127_ligorio_syllabus_s20.pdf
- For example,
- Place the file into its corresponding department and course within the
syllabi/directory- For example,
CS127_ligorio_syllabus_s20.pdfshould go intosyllabi/CS/CS_127/
- For example,
That's it!
If you are adding a syllabus for a new course which isn't accounted for yet, you will first have to take these additional steps:
- Create a new directory for the course under its department in
syllabi/- For example,
syllabi/CS/CS_127
- For example,
- Add the new course to its department's course map in
course_maps/- For example, a new computer science course would belong in the
CS.jsoncourse map
- For example, a new computer science course would belong in the
We now support adding thumbnails of faculty members next to the courses they're teaching:
To add a thumbnail:
- Place the image file in the
img/faculty/directory - The file name should correspond to the faculty member's name used in the syllabi files
- For example, to pair a thumbnail with
CS127_ligorio_syllabus_s20.pdf, we would name the thumbnail fileligorio.jpg
- For example, to pair a thumbnail with
- The image should be in JPG format
- Please try to keep the dimensions of the image within the low hundreds of pixels per side. The average image size is around
200x200.
We've generalized our infrastructure to support multiple departments. Each department's syllabus bank gets published to a subpage denoted by its code , e.g. http://syllabi.hunterosc.org/philo for the philosophy department.
A department is defined by the following:
- A course map within the
course_maps/directory, e.g.course_maps/CS.json - A directory for the department's syllabi files within the
syllabi/directory, e.g.syllabi/CS/ - Some configuration info in
build/config.py- Currently the department's full name (e.g.
"CS": "Computer Science"), and a background selected fromimg/textures/(yes! we can customize the background per department). - This can be extended to further customize each department's page
- Currently the department's full name (e.g.
There is a lot of low-hanging fruit for improvements now that we've moved from Jekyll to our own Python-driven build process and simplified our CSS, everything is customizable. We welcome your ideas and contributions. For large changes feel free to open an issue so we can brainstorm together.
If you have any questions, ideas, or other feedback about the new iteration of the website, we set up a forum to discuss in #27.
- GitHub: Add support for preview deployments internal alpha experiment
- If this is rolled out, we will be to build a preview website for every pull request. This will enable contributors to preview their contributions without having to run anything locally (and similarly, to help us review contributions without needing to sync them to our computers).
- Talk to the CUNY Hunter department about allowing students to host websites from ENIAC
- Not only could it make for a very gratifying experience for students, but it can help us as a project implement many new interesting features. Currently the website is completely static -- we are using GitHub Pages for hosting, which comes with a set of limitations (there is no "backend"). See this article for an explanation of the limitations: https://www.wix.com/blog/static-vs-dynamic-website. As a simple example, if we hosted this website on ENIAC, we would be able to do something like keep a count of how many visitors we've had on each page, which departments and courses get the most traffic, etc. If we wanted to do this on a static website, we'd need to delegate to an external service like the draconian Google Analytics, which is out of the question (see: #31)
- Talk to the CUNY Hunter department about adopting this project and sponsoring its infrastructure costs
- Blake (@rvente) has been graciously paying for our domain for the last few years. In an ideal world the department would recognize the utility this project provides for the community and help us keep it running.
- Advocate for making CUNYFirst accessible by an open and un-obfuscated API so that students could build programs that utilize it and improve one another's lives
- Think of ways to help the CUNY Hunter student community at large. See Josh's (@joshnatis) writeup "Community Systems as a Learning Tool and Incentive: How a homegrown community and infrastructure can encourage students to learn outside of class while encouraging camaraderie and the adoption of the open source spirit" for some ideas.
Run the following (in any Unix shell, like bash) to generate HTML files for each department:
for department in `ls syllabi`; do
python3 build/build.py "$department"
doneYou can then open those HTML files in your browser and see how they look.
Thank you to anyone that's helped out, we <3 you!
