Documentation Review

This page highlights key challenges or enhancements to current documentation faced upon joining the project.

Unable To Run Server Due to Busy Port

Coming from milestone 1, the server would always and only run on port 5000. While this was not an issue for many of us, some team members had their port 5000 busy, thus the server would refuse to start.

To overcome this we added changes to the current logic that instead of only trying to run the server on port 5000, it would then keep on looking and trying on the next available ports if the current port it attempts to use is already in use.

Enhancing ReadMe

The readme has been improved by addition the section Help with Running the Project. This has been included because it took a long time actually understanding the readme to start up the project. Clear instructions have been given in this section to help users quickly start the project.

For the purposes of our new features added such as loging in we also used another API, JWT API, thus additional context has been given in the readme to obtain this API Key