Cerberus2290 / 42-on_campus_stats

A tool to provide live feedback on a 42 campus

Campus Statistics Dashboard

An awesome tool to give LIVE insights about your 42 campus

View Demo · Report Bug · Request Feature

About The Project

Due to the structure of the campus building in Kuala Lumpur, it was hard for bocals to gauge the amount of cadets present at any given time, the time they were spending on projects and measure productivity overall. That sparked an idea to create a web app to be hosted on a TV at the entrance of the campus.
It gives useful insights about who is on campus, what projects are they doing/finished aswell as give a little morale boost to the Cadets.
Please keep in mind that its best to view it on a TV.

Built with

Frontend

Backend

Deployed on

(back to top)

Installation & Usage

note: install backend first

Click for Backend

• Navigate to /backend

cd backend

• Create a virtual environment in python

python3 -m venv venv

• Install dependencies

pip install -r requirements.txt

• Create .env file with secrets, you may find your API keys on the intra, create a new application if you dont have one.
  

touch .env

• .env file example

FT_API_UID = "YOUR_UID_HERE"
FT_API_SECRET = "YOUR_SECRET_HERE"
FT_CAMPUS_ID = "YOUR_FT_CAMPUS_ID_HERE"
#tip: [How to find your campus id](https://google.com)

• Run the backend

flask run

Click for Frontend

• Navigate /frontend

cd frontend

• Install dependencies

pnpm install

• Create .env file with the backend url

touch .env

• .env file example

REACT_APP_BACKEND_API_URL="your_backend_url_here" #if run locally, usually http://localhost:5000/api

• Run frontend

pnpm start

Usage

Roadmap

• Deploy project
• Connecting Frontend with Backend
• Configure view to fit tv
• Replace skills chart with something more useful
  • Remove skill spider chart
  • Add Top 5 most online users per week
  • Add Top 5 most experienced gained per week
• Convert Styled Components to use Tailwind CSS
• Convert existing component files written in .js to .tsx
• Auto refresh TV when new deployment happen
• Refactor Code
• Update User Interface
• Change Color Scheme

See the open issues for a full list of proposed features (and known issues).

How To Contribute

• Kindly fork this repo if you wish to use it on your own campus.

• Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Acknowledgments

• Bunyod for the initial idea and backend contribution
• Jaclyn for the frontend and UI/UX
• Jason for frontend
• Kevin for helping with Bug Fixes

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)