wHere App is a full stack project made with Nodejs, Expressjs, Reactjs, MongoDB, Mongoose.
It is a mobile-friendly responsive app that allows users to see find belongings that have been stored in containers represending physical locations in their home, such as the kitchen, the living room and many other rooms in the house.
This is the backend section of the project and contains all the code for the API endpoint which can be accessed via the frontend to display all the relevent data.
To get see all the docs and available endpoints for this API, visit the live site linked above or follow the steps below to get started.
The instructions below will give you all the steps necessary to view this project and add contributions if you wish.
-Install Node.js the runtime environment for this project. -Install npm to manage all of the required dependencies.
Follow this link to download Node.js and npm.
Version used on this project: Node v16.0.0
Clone this repository to your local machine by running the following command in your terminal:
git clone https://github.com/kamakazee/wHere_Backend/
Once cloned, navigate to the folder to the repository and run:
npm install
Doing so will install all necessary dependencies used in the project.
To run the website locally, run the following command in the terminal:
npm start
Whilst this command is running, the API and its endpoints can be locally accessible via localhost: