Modern Internet Technologies
Rashed Al-Lahaseh - 00821573
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
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.
-
Install Node.js
-
Install Angular CLI
npm install -g @angular/cli
-
Install LoopBack 4 CLI
npm install -g @loopback/cli
-
Install MongoDB
-
Clone the project
-
Building backend project
cd ./thd-server
thennpm install && build
-
Building front-end side
cd ./thd-app
thenng install && build
-
Run MongoDB
mongod
-
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.
-
Run backend project
cd ./thd-server
thennpm start
-
Run front-end project
cd ./thd-app
thenng serve
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