Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MichaelGatesDev/ccss-support-manual
Classroom Support Manual for Classroom Customer Support Services at SUNY Plattsburgh
https://github.com/MichaelGatesDev/ccss-support-manual
backend frontend monorepo multiplatform nodejs react suny-plattsburgh typescript yarn
Last synced: about 2 months ago
JSON representation
Classroom Support Manual for Classroom Customer Support Services at SUNY Plattsburgh
- Host: GitHub
- URL: https://github.com/MichaelGatesDev/ccss-support-manual
- Owner: MichaelGatesDev
- License: mit
- Archived: true
- Created: 2019-03-06T14:29:48.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-08T19:00:10.000Z (over 3 years ago)
- Last Synced: 2023-03-01T04:10:48.909Z (over 1 year ago)
- Topics: backend, frontend, monorepo, multiplatform, nodejs, react, suny-plattsburgh, typescript, yarn
- Language: TypeScript
- Homepage:
- Size: 7.99 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CCSS Support Manual [](https://travis-ci.com/MichaelGatesDev/ccss-support-manual)
## Notes
This 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.
## Purpose
The purpose of this project is to create a data-modular, centralized platform for troubleshooting classroom issues.
The application is designed to work for SUNY Plattsburgh, but can easily be modified to work at any other organization or university as well.
## Development
To 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.
It is best to think of this project as having multiple NodeJS sub-projects which all worktogether.
### Building
#### Pre-requisites
* [NodeJS](https://nodejs.org/en/) version 12.0 or higher
* [Yarn](https://yarnpkg.com/) version 2 or higher
#### Getting Started
1. Clone the repo
```
git clone [email protected]:MichaelGatesDev/ccss-support-manual.git
cd ccss-support-manual
```
2. Install dependencies and transpile
```
yarn install
```
### Packaging the application into binaries
This package uses [Electron Forge](https://www.electronforge.io/) to create multiplatform binaries of NodeJS projects.
To package the binaries, run the following:
```
yarn build
```
This will create an `out` folder in `packages/application/`, which will contain both a zipped and unzipped Windows build.
### Running the application
The application is split into two main parts: backend, frontend. To run the application, you need to run **both** the backend **and** the frontend.
To run the backend:
`yarn start:backend`
To run the frontend:
`yarn start:frontend`
To run both headless (no popups):
`yarn start:dev:headless`
To run the backend, frontend, and launch electron:
`yarn start:dev`
### Contributing
#### Pull Requests
This 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.
#### Issues / Feature Requests
If 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.
## Screenshots
### Home Page
### Room Example
