README.md

Course

Modern Internet Technologies

Project

TH-Deg International Office

Team members

Rashed Al-Lahaseh - 00821573

Resources

Requirements

• TypeScript v. 4.*
• Angular CLI v. 13.0.0
• MongoDB Atlas Free version
• MonoDB Community Edition v. 5.0.3
• LoopBack CLI v. 4.*
• Socket.io v. 4.4.0

Dependencies

• @angular/material v. 12.2.12
• MongoDB connector v. 6.1.0
• bcrypt.js v. 2.4.3
• JWT v. 8.5.1
• @compodoc/compodoc Used for @angular documentation

Documentation

Project

• Navigate to the WiKi Page which has long-form content and description about the project.

Angular(Front-end) Documentation

• Run compodoc -p tsconfig.doc.json -s which will use the comments and description used in the app to create a web content documentation.

Loopback(Backend) Documentation

• After running the server, navigate to http://localhost:3000/explorer which will open Swagger file used to describe and document RESTful APIs.

Instalition

1. Install Node.js

2. Install Angular CLI npm install -g @angular/cli

3. Install LoopBack 4 CLI npm install -g @loopback/cli

4. Install MongoDB

5. Clone the project

Building

1. Building backend project cd ./thd-server then npm install && build

2. Building front-end side cd ./thd-app then ng install && build

Run Application

1. Run MongoDB mongod

2. Import database records (Optional)

• There is folder attached to the repo under name database which is a dump folder listing collections of our database that could be used to restore.
• Use the following cmd mongorestore -d thd-international-office <dumb-file-location> to restore database.

3. Run backend project cd ./thd-server then npm start

4. Run front-end project cd ./thd-app then ng serve

Note

For database there is two configurations has been added to the datasource, the default one is connected to localhost but there is also configuration connected to Atlas MongoDB incase cloud connection is needed