This is a backend web service for the WhoGet mobile and web application. It exposes API endpoints where the mobile and web versions of the application can make CRUD operations to the application's database. The WhoGet backend server is developed with ExpressJS - a Nodejs Framework for writing application API's. The database management system is MongoDB and Mongoose is used as the object document mapper (ODM) for manipulating and querying the database.
In order to setup this application on your local machine, you need to follow the steps below.
- Clone the this repository to your local machine using the command below
git clone https://github.com/kimbohlovette/whoget-app-server.git
Navigate to the root directory with cd whoget-app-server command.
- In the root directory, run
npm installcommand to install all dependencies needed for the app to run. - Setup a connection to MongoDB. Create a
.envfile at the root folder and assign credientials to the variables as folllows
MONGODB_NAME='your user name'
MONGODB_PWD='password'
MONGODB_APPNAME='application name'
MONGODB_DBNAME='database name'
- Run
npm run devstart the development server.
This is an already hosted server for this application. https://whoget-app-server.onrender.com
Method: GET
http://localhost:5000/api/v1/asks?pag=1&limit=5
Endpoint to fetch asks.
Query parameters; page and limit provide pagination parameters for which page to show and how many elements to display.
Returns a list of of asks based on page number and limit.
{
"success": true,
"message": "fetch operation succesful",
"asks": [
{
"id": "643791b25e5e075183257f15",
"message": "I need brand new Pixel 4xl 128GB in Buea Asap",
"expirationDate": "Sat Apr 15 2023",
"createdAt": "Thu Apr 13 2023",
"locaton": "Limbe",
"imageUrl": "path/to/askImage.png",
"categoryId": "64383abb4413b4561f3b9d33",
"userId": "64378d001c6d5c18ddd79514",
"status": "visible",
"activities": []
},
{
"id": "6447f64195d4a63c6eac9827",
"message": "I need a Modem in Bamenda around City Chemist. It should be new and in good condition.",
"expirationDate": "Tue Apr 25 2023",
"createdAt": "Tue Apr 25 2023",
"locaton": "Bamenda",
"imageUrl": "https://firebasestorage.googleapis.com/v0/b/whoget-assets.appspot.com/o/images%2Feyong_vanisiah.jpg?alt=media&token=bcaa0792-e2f1-4d5b-b219-16bce322a1f3",
"categoryId": "64476a85589087b65a20cd05",
"userId": "64378d001c6d5c18ddd79514",
"status": "visible",
"activities": []
}
]
}
If no asks are found, the server returns an empty array.
{
"success": true,
"message": "fetch operation succesful",
"asks": []
}
Method: GET
localhost:5000/api/v1/asks/643791b25e5e075183257f15
Endpoint to fetch a single ask by ID. It takes the user ID as a request parameter and response with a JSON object which looks like below.
{
"success": true,
"message": "get ask operation successful",
"ask": {
"id": "643791b25e5e075183257f15",
"message": "I need brand new Pixel 4xl 128GB in Buea Asap",
"expirationDate": "Sat Apr 15 2023",
"createdAt": "Thu Apr 13 2023",
"locaton": "Limbe",
"imageUrl": "path/to/askImage.png",
"categoryId": "64383abb4413b4561f3b9d33",
"userId": "64378d001c6d5c18ddd79514",
"status": "visible",
"activities": []
}
}
If the ask with given ID is not found it returns a 404 error response.
{
"success": false,
"message": "the request params is not valid"
}
Method: POST
localhost:5000/api/v1/asks
This endpoint is used to create an Ask. It takes a payload (Ask object), use it to create an Ask document on the database and returns a new Ask ojbect Example request body 👇
{
"message": "I need a Full Stack Web developer. He should be based in Bamenda, has at least 2 years of experience in React, Redux, Express, MongoDB. Knowledge of PostGreSQL is a plus.",
"categoryId": "644a978cf4bb74db2e2806f8",
"location": "Bemenda",
"imageUrl": "https://firebasestorage.googleapis.com/v0/b/whoget-assets.appspot.com/o/images%2Feyong_vanisiah.jpg?alt=media&token=bcaa0792-e2f1-4d5b-b219-16bce322a1f3",
"expirationDate": "Tue Apr 25 2023",
"status": "visible",
"userId": "64378d001c6d5c18ddd79514"
}
This endpoint returns an object with a success massage and the newly created ask as below 👇
{
"success": true,
"message": "ask successfully created",
"newAsk": {
"id": "644a97b7f4bb74db2e2806fb",
"message": "I need a Full Stack Web developer. He should be based in Bamenda, has at least 2 years of experience in React, Redux, Express, MongoDB. Knowledge of PostGreSQL is a plus.",
"categoryId": "644a978cf4bb74db2e2806f8",
"imageUrl": "https://firebasestorage.googleapis.com/v0/b/whoget-assets.appspot.com/o/images%2Feyong_vanisiah.jpg?alt=media&token=bcaa0792-e2f1-4d5b-b219-16bce322a1f3",
"location": "Bemenda",
"userId": "64378d001c6d5c18ddd79514",
"createdAt": "2023-04-27T15:41:43.106Z"
}
}
Method: PATCH
localhost:5000/api/v1/asks/643791b25e5e075183257f15
Endpoint to update a single Ask item in the database. It takes a request body (payload) which contains fields that are to be updated, updates just those fields in the database and returns the newly updated Ask.
Example request body 👇
{
"message": "I need a Full Stack Web developer. The applicant should be comfortable working remotely, has at least 2 years of experience in React, Redux, Express, MongoDB. Knowledge of PostGreSQL is a plus.",
"location": "Douala",
"expirationDate": "Tue May 25 2023",
"userId": "64378d001c6d5c18ddd79514"
}
Server response 👇
{
"success": true,
"message": "update operation successful",
"updated": "644a97b7f4bb74db2e2806fb"
}
Notice that the expiration date has changed, same with the location and the message.
Method: DELETE
localhost:5000/api/v1/asks/643791b25e5e075183257f15
Endpoint to delete a single Ask from the database. It takes a request parameter id (the user id) and returns the ID of the deleted ask.
A sample delete response is as shown below.
{
"success": true,
"deletedId": 643791b25e5e075183257f15
}
Method: POST
localhost:5000/api/v1/users
The endpoint to create a user. It takes a request body which consists of a user object (payload) and returns the newly created user. Example request body 👇
{
"name": "Nfor Marie",
"phoneNumber": "691315183",
"email": "[email protected]",
"profileImage": "https://firebasestorage.googleapis.com/v0/b/whoget-assets.appspot.com/o/images%2Feyong_vanisiah.jpg?alt=media&token=bcaa0792-e2f1-4d5b-b219-16bce322a1f3",
"role": "user",
"status": "active"
}
Example response body 👇
{
"sucess": true,
"message": "create user operation successful",
"newUser": {
"id": "644ada78cb176502d3ed1c22",
"name": "Nfor Marie",
"phoneNumber": 691315183,
"email": "[email protected]",
"role": "user",
"profileImage": "https://firebasestorage.googleapis.com/v0/b/whoget-assets.appspot.com/o/images%2Feyong_vanisiah.jpg?alt=media&token=bcaa0792-e2f1-4d5b-b219-16bce322a1f3",
"createdAt": "9:26:32 PM"
}
}
Method: GET
localhost:5000/api/v1/users?page=1&limit=3
Endpoint to fetch users in the database. It accepts query parms; page and limit for pagination.
Returns a list of users for a particular page and page limit.
Example 👇
{
"success": true,
"message": "fetch operation successful",
"users": [
{
"id": "6447d65c609ca79f62958e25",
"name": "Tatiana Manaoas",
"email": "[email protected]",
"createdAt": "2023-04-25T13:32:12.776Z",
"role": "user",
"profileImage": "https://firebasestorage.googleapis.com/v0/b/whoget-assets.appspot.com/o/images%2Feyong_vanisiah.jpg?alt=media&token=bcaa0792-e2f1-4d5b-b219-16bce322a1f3",
"status": "active"
},
{
"id": "6447d65c609ca79f62958e23",
"name": "Nsong Stella Mesode",
"email": "[email protected]",
"createdAt": "2023-04-25T13:32:12.767Z",
"role": "user",
"profileImage": "https://firebasestorage.googleapis.com/v0/b/whoget-assets.appspot.com/o/images%2Feyong_vanisiah.jpg?alt=media&token=bcaa0792-e2f1-4d5b-b219-16bce322a1f3",
"status": "active"
},
{
"id": "6447d65c609ca79f62958e27",
"name": "Tatiana Manaoas",
"email": "[email protected]",
"createdAt": "2023-04-25T13:32:12.780Z",
"role": "user",
"profileImage": "https://firebasestorage.googleapis.com/v0/b/whoget-assets.appspot.com/o/images%2Feyong_vanisiah.jpg?alt=media&token=bcaa0792-e2f1-4d5b-b219-16bce322a1f3",
"status": "active"
}
]
}
Method: GET
localhost:5000/api/v1/users/<user_id>
Endpont to fetch a single user by ID. It takes request parameter id and return a single user if found or 404 if not found.
Example response for URL localhost:5000/api/v1/users/6447d65c609ca79f62958e23
{
"success": true,
"message": "get user successful",
"user": {
"id": "6447d65c609ca79f62958e23",
"name": "Nsong Stella Mesode",
"email": "[email protected]",
"profileImage": "https://firebasestorage.googleapis.com/v0/b/whoget-assets.appspot.com/o/images%2Feyong_vanisiah.jpg?alt=media&token=bcaa0792-e2f1-4d5b-b219-16bce322a1f3",
"role": "user",
"status": "active",
"createdAt": "2023-04-25T13:32:12.767Z"
}
}
Method: GET
localhost:5000/api/v1/users/<user_id>/asks
This endpoints returns all Asks placed by a User. It takes user's id, id as a request params.
Example (localhost:5000/api/v1/users/localhost:5000/api/v1/users/6447d65c609ca79f62958e23/asks)
{
"success": true,
"message": "fetch operation successful",
"asks": [
{
"id": "6447f64595d4a63c6eac982d",
"message": "Hello everyone. I need a farmer who can supply me tomatoes on daily basis. I am in Kumba",
"expirationDate": "2023-04-25T15:48:13.000Z",
"location": "Kumba",
"imageUrl": "https://firebasestorage.googleapis.com/v0/b/whoget-assets.appspot.com/o/images%2Feyong_vanisiah.jpg?alt=media&token=bcaa0792-e2f1-4d5b-b219-16bce322a1f3",
"status": "visible",
"activities": [],
"createdAt": "2023-04-25T15:48:21.766Z"
}
],
"numOfAsks": 1
}
Method: PATCH
localhost:5000/api/v1/users/<user_id>
Endpoint to update user fields. It takes receives a request body (payload) object that contains only the user properties to be replaced. It returns the newly updated User object.
Example
http://localhost:5000/api/v1/users/6447d65c609ca79f62958e23
Request body 👇
{
"name": "Estella Shembum"
}
Response 👇
{
"success": true,
"message": "update user successful",
"updated": {
"id": "6447d65c609ca79f62958e23",
"name": "Estella Shembum",
"email": "[email protected]",
"profileImage": "https://firebasestorage.googleapis.com/v0/b/whoget-assets.appspot.com/o/images%2Feyong_vanisiah.jpg?alt=media&token=bcaa0792-e2f1-4d5b-b219-16bce322a1f3",
"role": "user",
"status": "active",
"updatedAt": "2023-04-28T02:38:35.030Z"
}
}
Method: DELETE
localhost:5000/api/v1/users/<user_id>
This is the endpoint to remove a user object. It takes a request params id and returns the id of the deleted user object.
Response for http://localhost:5000/users/348d8er8348erdd8d438ddfg
{
"success": true,
"deletedId": "348d8er8348erdd8d438ddfg"
}
Method: GET
localhost:5000/api/v1/categories
Endpoint to fetch all categories in the database. It also gives room for pagination. That is page and limit query params can be used to limit what the user wants. It returns a list of categories.
Method: GET
localhost:5000/api/v1/categories/`<category_id>`/asks
Endpoint to fetch all asks belong to a category. It receives a request parameter, id and returns an array of all asks that belong to that category.
Method: POST
localhost:5000/api/v1/categories
Creates a category. Receives a request body name of the category (e.g { name: "Technology" } ) and returns the newly created category ( e.g { id: dfkdfhg49dfj3dffkf", name: "Technology" })
Method: DELETE
localhost:5000/api/v1/categories
Deletes a category from the data store and returns the id of the deleted category.