_{Created by Amedeo Majer (ame)}

About tech-report

The tech-report app provides Hive students with a platform to report technical issues related to the school's IT equipment. This tool enables staff members to efficiently address and follow up on these reported issues.

The primary objective of this app is to guide students in correctly reporting technical problems and to maintain a record of these issues. In the near future, by tracking and documenting the reported incidents, the app will help identify any recurring problematic equipment. This information can be valuable for improving the school's IT infrastructure and ensuring a smoother experience for all students.

Screenshots:

Requirements

This app is developed to run with the 42 OAuth. You will first need to create a 42 API app in the intranet.

Instructions

1. Create a new API application on the 42 intranet
2. In the field Redirect URI add: http://localhost:3000/api/auth/callback/42-school
3. In the scopes select "Access the user public data" and submit.
4. Save the credentials you will need them later.

Getting Started

Clone the repository locally

git clone [email protected]:hivehelsinki/tech-report.git
cd tech-report

Install all the necessary dependencies run the following

npm install

Migrate the database

npx prisma migrate dev

Create the .env file

cp .env.sample .env

key	desc
CAMPUS_ID	Your campus ID on the intranet
FT_UID	Your 42API UID starting with u-s4t2af
FT_SECRET	Your 42API Secret starting with s-s4t2af
SECRET	Fill with random string
NEXTAUTH_URL	URL of your app (e.g: https://report.domain.nl)
SLACK_URL	Slack incoming webhook URI (remove if disable)

Run the application

npm run dev

Now you can access you application on localhost:3000

Customization

If you want to change the logo by the ones of your school, you change the following files:

• ./public/landingPageLogo.svg: The logo of your school that will be shown in the signIn page
• ./src/components/Logo.jsx: The logo in the navbar

You can edit the config.yml file to change:

• the app title
• faulty devices list
• hosts list

Docker

Build docker image

docker build -t tech-report .

Run the container

docker run -v `pwd`/.env:/app/.env -p 3000:3000 --name tech-report --rm tech-report

Access the container's logs

docker logs -f tech-report

GDPR

The application stores the following information:

• Student login
• Student profile picture intra url (anonymized when 42 anonymized a user)