Haley's Hope Student Tracker is a platform that simplifies and digitizes the process of tracking student test results and growth, eliminating the need to constantly dig through physical student records. The platform provides a central hub to academic assessment coordinators, allowing them to enter assessment scores for various tests. This generates comprehensive assessment result forms, making it easy to identify strengths and weaknesses in students' performance. Regular accounts can add new students, edit the student details, assign assessments, edit assessments, and view the results. Admin accounts have the authority to assign or remove access, add or remove coaches, and manage student information seamlessly. Student Tracker goes beyond data entry; it allows you to visualize student progress with graphs and charts. Easily compare test results and gain a deeper understanding of each student's development. Join us in the digital transformation of record management. The Student Tracker empowers you to work smarter, not harder, and make data-driven decisions that truly impact student growth. The assessments supported are the CTOPP-2 ages 4-6 and 7-24, WIST 7-11 and 11-18, GORT-5, and KTEA-3.
- Javascript - Core Language
- CSS - CSS styling
- HTML - HTML5
- Express.js - RESTful API Web App Framework
- Passport.js - Authentication
- bcrypt.js - Password Hashing and Salting
- React - User interface with components
- React Redux - Read store data and dispatch actions to update state
- React Sagas/Routers - Redux side effect manager
- Material_UI - React UI tools
- PostgreSQL - Relational Database System
- Postico2 - Local Database
- Postman - For testing APIs
- SweetAlert2 - Customized Popup Boxes
- Fuse.js - Fuzzy search library
- Node.js - runtime enviroment
- Axios - HTTP client
- Tailwind - Inline Styling
- Cloudinary - Image importing
- UI/Shadcn - Reusable UI components
- Highcharts - Interactive graphs
- Cron - Automated tasks based on date / yearly renewed task
- Fly.io - Deployment
- Axios - Promise based HTTP Client / database communications
This project should be able to run in your favorite IDE. We used VS code while building it.
Before you get started, make sure you have the following software installed on your computer:
- Fork the repository
- Copy the SSH key in your new repository
- In your terminal type...
git clone {paste SSH link} - Navigate into the repository's folder in your terminal
- Open VS Code (or editor of your choice) and open the folder
- In the terminal of VS Code run
npm installto install all dependencies - Create a
.envfile at the root of the project and paste this line into the file:SERVER_SESSION_SECRET= {your server secret} - Create a database named
student_trackerin PostgresSQL If you would like to name your database something else, you will need to changestudent_trackerto the name of your new database name inserver/modules/pool.js - The queries in the database.sql file are set up to create all the necessary tables that you need, as well as a dummy data table to test the app. Copy and paste those queries in the SQL query of the database. If this is going to production, leave out the dummy data.
- Run
npm run serverin your VS Code terminal - Open a second terminal and run
npm run client
Once everything is installed and running it should open in your default browser - if not, navigate to http://localhost:3000/#/.
-
Login Credentials for Fly.io have been provided in the hand off document.
-
If you need to make changes you wish to push to the deployed app, you must login, go into the haleys-hope section, go to the deploy tab, and then manually deploy. You can reconfigure this to redeploy automatically if you wish, which is on the same page.
-
Environment variables are kept on Fly.io in the Secrets tab.
-
To set up the DB, TODO: (fill this out)
-
The first user of the app will automatically be an admin.
David Campbell, Said Said, Kenny Ferguson