As part of the assessment process for the IS-24 Full Stack Developer Position, I developed a web application that manages and tracks other web applications created by the Province of BC.
1. Cloning the repository (only once):
git clone https://github.com/anant00729/anant-sunilam-awasthy-IS24-full-stack-competition-req97073.git
2. Installing NodeJS:
-
Check to see if you have Node.js installed. On a Mac use the command
node-v
in terminal. If it is installed, the version in use will be reported in the terminal. If not, install it from node.js. -
Check to see if you have npm installed. On a Mac use the command
npm -v
. If it is installed, the version will be reported. If you do not have it installed, runnpm install -g npm
in a terminal.
3. Configuring the project (only once):
At the root folder of the project, run the following commands
npm i # Installs the dependencies
npm i -D # Installs development dependencies
npm start # Runs the NodeJs server
4. Viewing the project:
Launch a web browser and navigate to the specified URL.
http://localhost:5010/
5. Viewing the Swagger Documentation:
Launch a web browser and navigate to the Swagger Documentation.
http://localhost:5010/api/api-docs/
Make sure you have docker installed in your system. Installation Link
To use Docker for running the project, navigate to the root level of the project where the docker-compose.yml file is located and execute the following command:
docker-compose up -d