• Tech stack
  • Azure active directory
  • DYMO printer
  • Front end
    • React
    • Material-UI
  • Back end
  • Node.js
  • Pyton Flask-app
  • Email
• Getting the project up and running
  • Environment variables
    • Node.js environment variables
    • Flask environment variables
  • Active directory integration
  • Setting up the database
  • Running locally
    • Node-js and front end
    • Flask

This solution uses Oauth 2.0 and Azure active directory to authenticate users who try to access the admin interface

The front end consists of a user front end where users can register lost items, and an admin front end where employees at the lost and found office can administer lost and found items.

The front end code is in /packages/grizzly

React.js was used to build the front end.

Components from the Material-UI library were used to build the front end.

The backend consists of a database where all data is stored, a Node.js server which handles requests from the front end, and a server which finds possible matches among the items which are registered as lost and found

The database used for this project is a postgres sql database.

The backend server responsible for handling requests from the front end runs node.js with express, and is written in Typescript. The backend server consists of a number of REST endpoints which are documented in the docs/api.yaml file. The api documentation follows the openAPI 3.0 specification.

The code for the backend can be found in /packages/backend. Whe running the backend locally the .env file must be places in the backend src directory. When running the backend locally it will default to running on localhost:5000

The Node.js code is in /packages/admin

The server responsible for finding possible matches runs in Python using the Flask framework. When a new item is registered as lost or found the Node.js server instructs the Flask server to check for possible matches. The code for the Flask app is not located in this repository.

Email is only implemented as a proof of concept. It sends email from a gmail account, and the username and password must be provided in the environment variables. To disable email use just don't provide gmail username and password. For email to work the gmail account needs to enable less secure apps.

When a user registers a new lost item, they receive a confirmation email. When someone at the office matches a found item with the users lost item the user receives an email informing them of the match and directing them to pick up their item. When 7 days has passed since the day the item was lost, the user receives an email informing them that it is unlikely that lost and found will find their item. 1 day after an item was lost the user will recieve an email informing them that they are still looking for the item.

Environment variables need to be provided to get the Node.js and Flask servers up and running. When running the servers locally the environment variables are provided in a .env

• DB_PASSWORD=password for the postgres database

• DB_HOST=the host of the postgres database

• DB_PORT=the port of the postgres database

• DB_NAME=the name of the postgres database

• DB_USER=the user for the postgres database

• CLIENT_ID=the Oauth2 client id for the oauth application

• CLIENT_SECRET=the Oauth2 secret id for the oauth application

• TENANT_ID=the tenant id for the oauth application

• RESOURCE_ID=the id for the resources used by the oauth application, must be https://graph.microsoft.com

• CALLBACK_URI=the callback uri of the oauth application, must be host/auth/azureoauth2/callback where host is where the backend server is hosted. For example https://hittegods.azurewebsites.net/auth/azureoauth2/callback

• GMAIL_USERNAME=the username for the gmail account used to send emails

• GMAIL_PASSWORD=the password of the gmail account used to send emails

• MATCH_BACKEND_HOST=the host for the flask app which does the matching

• REACT_APP_MATCH_BACKEND_HOST=the host for the flask app which does the matching

• DB_PASSWORD=password for the postgres database
• DB_HOST=the host of the postgres database
• DB_PORT=the port of the postgres database
• DB_NAME=the name of the postgres database
• DB_USER=the user for the postgres database

You must register a new azure oauth app. Callback uri must be host/auth/azureoauth2/callback where where host is where the backend server is hosted. Client id, client secret, tenant id, resource id and callback uri must be entered into the environment variables. Api permissions must be:

• email
• openid
• profile
• User.read

The hittegodsDB.sql file contains a dump from the database and can be used to restore the database with all required data. See https://www.postgresqltutorial.com/postgresql-restore-database/ for instructions for how to restore the database from the sql file. When the database has been set up the database password, host, port, name and used should be entered into the backend environment variables.

To run this project yarn and Node.js (>= 12.x) must be installed. Run yarn install in the root directory of the project to install all required modules. Put the .env file in /packages/backend. Put the .env file in /packages/grizzly. Run yarn start to start running both the front end and the backend. The front end and backend can be run individually by navigating to /packages/backend and /packages/grizzly and running yarn start

To run the flask application locally you need python and pip installed. To install all the required python packages to run the application navigate to the root directory the python project and run pip install -r requirements.txt. Crate a .env file in the root directory and enter:

• DB_PASSWORD=password for the postgres database
• DB_HOST=the host of the postgres database
• DB_PORT=the port of the postgres database
• DB_NAME=the name of the postgres database
• DB_USER=the user for the postgres database Run set FLASK_APP = Application.py. To start the application run flask run