WhatsThat?

This is the WhatsThat? API server code for the 22/23 Mobile Applications Development (6G6Z1104) server.

To get started, read the assignment brief and attend the assignment lecture.

For queries, contact Ashley Williams (ashley.williams@mmu.ac.uk).

Running the server

1. Clone the repository into a directory on your local machine. If you have Git installed on your machine then you can run git clone https://github.com/ash-williams/whatsthat in your terminal
2. In the terminal, navigate to the directory where you have cloned the repository and run npm install to install the dependencies
3. Run the server with npm run dev
4. Test everything is working using Postman. The API documentation can be found by navigating to http://localhost:3333/api/1.0.0/documentation in your browser.

Documentation

The API documentation can be found by running the server, and then navigating to http://localhost:3333/api/1.0.0/documentation in your browser.