This project aims to be a dashboard style website that serves as a one-stop shop for you to look at most of the things you'll want to know about UNC Charlotte, including how busy places are, what's open, and more. This project was heavily inspired by a discord bot showing occupancy levels made by @ironton on discord.
You can access the site at https://dudebehinddude.github.io/niner-monitor/. The site is built using React, and occupancy data is gathered from other sites through an external API. The code for this API can be found here.
If you encounter any issues or have suggestions for improvements, feel free to open an issue on this repository and provide details about the problem or feature request.
This project is built with Node.JS and Yarn. Ensure these are installed before preceding.
-
Clone the repository
-
Install dependencies:
yarn install
-
Start up the development server. The server should be accessible at localhost:3000/niner-monitor (setup this way for GitHub Pages)
yarn start
-
Alternatively, you can generate a production build of the project:
yarn build
By default, the project uses a hosted version of the API. To run the project with a local API:
- Visit the backend repo here and follow the instructions to setup the backend API.
- If instructions are followed correctly, the server should be hosted at
http://localhost:5096. Visiting here should take you to the Swagger API documentation page if you are in a development environment. If this doesn't work, make sure you followed the setup instructions correctly. - Further instructions will be added in the future.
This project is licensed under the MIT License. See the LICENSE file for more information.