Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jumagu/school-metrics

...
https://github.com/jumagu/school-metrics

Last synced: about 1 month ago
JSON representation

...

Host: GitHub
URL: https://github.com/jumagu/school-metrics
Owner: jumagu
Created: 2024-08-26T20:08:20.000Z (5 months ago)
Default Branch: master
Last Pushed: 2024-08-29T01:13:18.000Z (4 months ago)
Last Synced: 2024-08-30T02:29:08.113Z (4 months ago)
Language: TypeScript
Homepage:
Size: 2.52 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

School Metrics

Real-Time Student Insights, Enhanced Parent-Teacher Collaboration

View Demo

Table of Contents

About The Project
- Built With
- Contributors

Getting Started

## About The Project

Web application for evaluation and monitoring of school performance. It provides a complete system for teachers, parents and students. Among its main features are evaluation grading, report generation, private parent-teacher chat and administrative dashboard.

### Built With

Here are the major frameworks/libraries used to built this project:

![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
![NodeJS](https://img.shields.io/badge/Nodejs-43853D?style=for-the-badge&logo=node.js&logoColor=white)
![Express](https://img.shields.io/badge/Express-000000?style=for-the-badge&logo=express&logoColor=white)
![Prisma](https://img.shields.io/badge/Prisma-2D3748?style=for-the-badge&logo=prisma&logoColor=white)
![JWT](https://img.shields.io/badge/JWT-000000?style=for-the-badge&logo=json-web-tokens&logoColor=white)
![PostgreSQL](https://img.shields.io/badge/PostgreSQL-316192?style=for-the-badge&logo=postgresql&logoColor=white)
![Socket.IO](https://img.shields.io/badge/Socket.io-010101?style=for-the-badge&logo=socket.io&logoColor=white)
![Vite](https://img.shields.io/badge/Vite-646CFF?style=for-the-badge&logo=vite&logoColor=white)
![React](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)
![Redux](https://img.shields.io/badge/Redux-593D88?style=for-the-badge&logo=redux&logoColor=white)
![Axios](https://img.shields.io/badge/Axios-000000?style=for-the-badge&logo=axios&logoColor=white)
![Material-UI](https://img.shields.io/badge/Material_UI-0081CB?style=for-the-badge&logo=mui&logoColor=white)

### Contributors

#### Back End

| | | |
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| **Darvin Ricardo Alania Inocencio** | **Juan Santiago Usca Mamani** | **Ramiro Carnicer Souble** |
| | | |

#### Front End

| | |
| :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| **Juan Gutiérrez** | **Lina Naranjo** |
| | |

## Getting Started

### Prerequisites

For this project you need to have:

- Node.js 18 or higher installed on your local machine
- PostgreSQL 13 or higher or a Docker container with the image of PostgreSQL 13

If you do not have PostgreSQL or Docker installed, you can use a serverless platform like Neon to create a PostgreSQL database in the cloud.

### Installation

1. Clone the repo
```sh
git clone https://github.com/jumagu/school-metrics.git
```
2. Install NPM packages in both server and client

```sh
cd server
npm install

cd client
npm install
```

3. For both the server and the client, create a copy of the `.env.sample` file that is in the env folder of each and rename it to `.env`, then assign the corresponding values to the variables

4. Run the server
```sh
cd server
npm run prisma:migrate:dev
npm run prisma:reset:dev
npm run dev
```
5. Run the client
```sh
cd client
npm run dev
```

### User Credentials

#### Admin

- Email: [email protected]
- Password: admin123

#### Student

- Email: [email protected]
- Password: Av9Qj9Be

#### Parent

- Email: [email protected]
- Password: 8aacaBig

#### Teacher

- Email: [email protected]
- Password: mZK5aolP