Skip to content
This repository has been archived by the owner on Jun 21, 2021. It is now read-only.

Classroom Support Manual for Classroom Customer Support Services at SUNY Plattsburgh

License

Notifications You must be signed in to change notification settings

MichaelGatesDev/ccss-support-manual

Repository files navigation

CCSS Support Manual Build Status

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 version 12.0 or higher
  • Yarn version 2 or higher

Getting Started

  1. Clone the repo
git clone git@github.com:MichaelGatesDev/ccss-support-manual.git
cd ccss-support-manual
  1. Install dependencies and transpile
yarn install

Packaging the application into binaries

This package uses Electron Forge 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 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. There is a handy search feature to find similar issues which can help you troubleshoot.

Screenshots

Home Page

Room Example