{"id":13343413,"url":"https://github.com/MichaelGatesDev/ccss-support-manual","last_synced_at":"2025-03-12T04:33:39.742Z","repository":{"id":51957104,"uuid":"174160720","full_name":"MichaelGatesDev/ccss-support-manual","owner":"MichaelGatesDev","description":"Classroom Support Manual for Classroom Customer Support Services at SUNY Plattsburgh","archived":true,"fork":false,"pushed_at":"2021-05-08T19:00:10.000Z","size":8378,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-24T15:39:55.585Z","etag":null,"topics":["backend","frontend","monorepo","multiplatform","nodejs","react","suny-plattsburgh","typescript","yarn"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MichaelGatesDev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-06T14:29:48.000Z","updated_at":"2023-01-28T08:12:08.000Z","dependencies_parsed_at":"2022-08-23T16:31:06.226Z","dependency_job_id":null,"html_url":"https://github.com/MichaelGatesDev/ccss-support-manual","commit_stats":null,"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelGatesDev%2Fccss-support-manual","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelGatesDev%2Fccss-support-manual/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelGatesDev%2Fccss-support-manual/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelGatesDev%2Fccss-support-manual/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MichaelGatesDev","download_url":"https://codeload.github.com/MichaelGatesDev/ccss-support-manual/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243158975,"owners_count":20245668,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backend","frontend","monorepo","multiplatform","nodejs","react","suny-plattsburgh","typescript","yarn"],"created_at":"2024-07-29T19:31:18.666Z","updated_at":"2025-03-12T04:33:39.120Z","avatar_url":"https://github.com/MichaelGatesDev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CCSS Support Manual [![Build Status](https://travis-ci.com/MichaelGatesDev/ccss-support-manual.svg?branch=master)](https://travis-ci.com/MichaelGatesDev/ccss-support-manual)\n\n\n## Notes\n\nThis platform is designed specifically for SUNY Plattsburgh. Although you can make it work for any other workplace, it may become frustrating as some things are hardcoded (e.g. navigation links). Feel free to submit a pull-request to make it more modular if you'd like.\n\n\n## Purpose\n\nThe purpose of this project is to create a data-modular, centralized platform for troubleshooting classroom issues.\n\nThe application is designed to work for SUNY Plattsburgh, but can easily be modified to work at any other organization or university as well.\n\n\n## Development\n\nTo understand this project, you should know that the application is split into two main parts: the backend, which serves everything with an Express server, and the frontend, which is written in React and serves as the interface. \n\nIt is best to think of this project as having multiple NodeJS sub-projects which all worktogether.\n\n### Building\n\n#### Pre-requisites\n\n* [NodeJS](https://nodejs.org/en/) version 12.0 or higher\n* [Yarn](https://yarnpkg.com/) version 2 or higher\n\n#### Getting Started\n\n1. Clone the repo\n```\ngit clone git@github.com:MichaelGatesDev/ccss-support-manual.git\ncd ccss-support-manual\n```\n2. Install dependencies and transpile\n```\nyarn install\n```\n\n\n### Packaging the application into binaries\n\nThis package uses [Electron Forge](https://www.electronforge.io/) to create multiplatform binaries of NodeJS projects. \n\nTo package the binaries, run the following:\n```\nyarn build\n```\n\nThis will create an `out` folder in `packages/application/`, which will contain both a zipped and unzipped Windows build.\n\n\n### Running the application\n\nThe application is split into two main parts: backend, frontend. To run the application, you need to run **both** the backend **and** the frontend. \n\nTo run the backend:\n\n`yarn start:backend`\n\nTo run the frontend:\n\n`yarn start:frontend`\n\nTo run both headless (no popups):\n\n`yarn start:dev:headless`\n\nTo run the backend, frontend, and launch electron:\n\n`yarn start:dev`\n\n\n### Contributing\n\n#### Pull Requests\n\nThis project was written completely by myself, and I am still very much a beginner. Feel free to [submit a pull request](https://github.com/MichaelGatesDev/ccss-support-manual/pulls) if you implement some cool features.\n\n#### Issues / Feature Requests\n\nIf there's an issue with the application, whether it be a bug or glitch or a missing feature you'd like to see, please [submit an issue ticket](https://github.com/MichaelGatesDev/ccss-support-manual/issues). There is a handy search feature to find similar issues which can help you troubleshoot.\n\n\n## Screenshots\n\n### Home Page\n\n![](https://i.imgur.com/vIbb8Vr.png)\n\n### Room Example\n\n![](https://i.imgur.com/cBtv1mz.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMichaelGatesDev%2Fccss-support-manual","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FMichaelGatesDev%2Fccss-support-manual","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMichaelGatesDev%2Fccss-support-manual/lists"}