Skip to content

Latest commit

 

History

History
515 lines (442 loc) · 17.8 KB

README.md

File metadata and controls

515 lines (442 loc) · 17.8 KB
Raw

stuCamp Backend

Getting started

Installing Dependencies

Nodejs 16.18.0 Follow instructions to install the latest version of nodejs for your platform in the nodejs docs

NPM Dependencies

Once you have your virtual environment setup and running, install dependencies by navigating to the /backend directory and running:

`npm install`

This will install all of the required packages we selected within the package.json.

Key Dependencies

Express is a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications

Mongoose provides a straight-forward, schema-based solution to model your application data. It includes built-in type casting, validation, query building, business logic hooks and more, out of the box.

Running the server

From within the ./backend directory You can either run it as development or prodcution mode. Each time you open a new terminal session, run:

`npm run start:dev`  -  development mode
`npm run start:prod` -  production mode

API Reference

Stucamp API full documentation

Getting Started

Base URL: Currently this application is only hosted locally. The backend is hosted at http://127.0.0.1:3000/api/v1

Authentication: Json Web Token (JWT) is used for authentication. NB: Only a successfully logged in admin and hostel owners can perform DELETE AND PATCH actions.

Error Handling

Errors are returned as JSON in the following format:

{
    "status": "fail",
    "error": {
        "statusCode": 404,
        "status": "fail",
        "isOperational": true
    },
    "message": "Hostel was not found",
    "stack": "Error: Hostel was not found\n"
}

The API will return four types of errors:

400 - bad request
404 - resource not found
401 - unauthorized
500 - internal server error

API Endpoints

Hostel Resources

GET /hostels General: Returns a list of hostels.

Sample: curl http://127.0.0.1:3000/hostels

{
    "status": "success",
    "results": 5,
    "data": {
        "hostels": [
            {
                "images": [
                    "hostel-2-1.jpg",
                    "hostel-2-2.jpg",
                    "hostel-2-3.jpg"
                ],
                "_id": "6370066e0bc496358dba995b",
                "name": "Learners' garden hostel",
                "type": "self-contain",
                "price": 95000,
                "ratingsAverage": 2.5,
                "roomsAvailable": 12,
                "closeBy": true,
                "summary": "Stable electricity, running water, fenced,  and much more",
                "description": "Consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\nIrure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.",
                "imageCover": "hostel-2-cover.jpg",
                "slug": "learners'-garden-hostel"
            },
            {
                "images": [
                    "hostel-1-1.jpg",
                    "hostel-1-2.jpg",
                    "hostel-1-3.jpg"
                ],
                "_id": "6370066e0bc496358dba995a",
                "name": "King'n'Queen hostel",
                "type": "self-contain",
                "price": 75000,
                "ratingsAverage": 3.5,
                "roomsAvailable": 6,
                "closeBy": true,
                "summary": "Stable electricity, running water, fenced,  and much more",
                "description": "Consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\nIrure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.",
                "imageCover": "hostel-1-cover.jpg",
                "slug": "king'n'queen-hostel"
            },
            {
                "images": [
                    "hostel-3-1.jpg",
                    "hostel-3-2.jpg",
                    "hostel-3-3.jpg"
                ],
                "_id": "6370066e0bc496358dba995c",
                "name": "Arafims hostel",
                "type": "single-room",
                "price": 45000,
                "ratingsAverage": 3.5,
                "roomsAvailable": 10,
                "closeBy": false,
                "summary": "Stable electricity, well-water",
                "description": "Consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\nIrure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.",
                "imageCover": "hostel-3-cover.jpg",
                "slug": "arafims-hostel"
            },
            {
                "images": [
                    "hostel-4-1.jpg",
                    "hostel-4-2.jpg",
                    "hostel-4-3.jpg"
                ],
                "_id": "6370066e0bc496358dba995e",
                "name": "Gulf pearl apartment",
                "type": "apartment",
                "price": 155000,
                "ratingsAverage": 2.5,
                "roomsAvailable": 2,
                "closeBy": true,
                "summary": "Stable electricity, running water, fenced, security and much more",
                "description": "Consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\nIrure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.",
                "imageCover": "hostel-4-cover.jpg",
                "slug": "gulf-pearl-apartment"
            },
            {
                "images": [
                    "hostel-3-1.jpg",
                    "hostel-3-2.jpg",
                    "hostel-3-3.jpg"
                ],
                "_id": "6370066e0bc496358dba995d",
                "name": "Queens hostel",
                "type": "self-contain",
                "price": 45000,
                "ratingsAverage": 3.5,
                "roomsAvailable": 5,
                "closeBy": false,
                "summary": "Stable electricity, well-water",
                "description": "Consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\nIrure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.",
                "imageCover": "hostel-3-cover.jpg",
                "slug": "queens-hostel"
            },
        ]
    }
}

GET /hostels/:id General: Returns a single hostel based on id.

Sample: curl http://127.0.0.1:3000/hostels/6370066e0bc496358dba995d

{
    "status": "success",
    "data": {
        "hostel": {
            "images": [
                "hostel-2-1.jpg",
                "hostel-2-2.jpg",
                "hostel-2-3.jpg"
            ],
            "_id": "6370066e0bc496358dba995b",
            "name": "Learners' garden hostel",
            "type": "self-contain",
            "price": 95000,
            "ratingsAverage": 4.5,
            "roomsAvailable": 12,
            "closeBy": true,
            "summary": "Stable electricity, running water, fenced,  and much more",
            "description": "Consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\nIrure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.",
            "imageCover": "hostel-2-cover.jpg",
            "slug": "learners'-garden-hostel",
        }
    }
}

GET /top-5-cheap General: Returns top 5 cheap hostels.

Sample: curl http://127.0.0.1:3000/hostels/top-5-cheap

{
    "status": "success",
    "results": 5,
    "data": {
        "hostels": [
            {
                "_id": "6374a699719ad05f690e3148",
                "name": "Rubiks hostel",
                "type": "single-room",
                "ratingsAverage": 4.5,
                "price": 45000
            },
            {
                "_id": "6374a699719ad05f690e3146",
                "name": "Pyramid hostel",
                "type": "self-contain",
                "ratingsAverage": 4.5,
                "price": 45000
            },
            {
                "_id": "6374a699719ad05f690e3144",
                "name": "Queens hostel",
                "type": "self-contain",
                "ratingsAverage": 3.5,
                "price": 45000
            },
            {
                "_id": "6374a699719ad05f690e3143",
                "name": "Arafims hostel",
                "type": "single-room",
                "ratingsAverage": 2.5,
                "price": 45000
            },
            {
                "_id": "6374a699719ad05f690e314a",
                "name": "Kikelomo hostel",
                "type": "single-room",
                "ratingsAverage": 3.5,
                "price": 55000
            }
        ]
    }
}

POST /hostels General: Returns a new hostel.

Sample: curl -d '{"name": "unique mansion hostel": "type": "single-room"}' http://127.0.0.1:3000/hostels -H 'Content-Type: application/json' -X POST

{
    "status": "success",
    "data": {
        "hostel": {
            "_id": "6370066e0bc496358dba995b",
            "name": "unique mansion hostel",
            "type": "single-room",
            "price": 95000,
            "roomsAvailable": 12,
            "closeBy": true,
            "summary": "Stable electricity, running water, fenced,  and much more",
            "slug": "unique-mansion-hostel",
        }
    }
}

PATCH /hostels/:id General: Returns updated hostel.

Sample: curl -d '{"name": "unique mansion hostel"}' http://127.0.0.1:3000/hostels/6370066e0bc496358dba995d -H 'Content-Type: application/json' -X PATCH

{
    "status": "success",
    "data": {
        "hostel": {
            "_id": "6370066e0bc496358dba995b",
            "name": "unique mansion hostel",
            "type": "self-contain",
            "price": 95000,
            "roomsAvailable": 12,
            "closeBy": true,
            "summary": "Stable electricity, running water, fenced,  and much more",
            "slug": "unique-mansion-hostel"
        }
    }
}

DELETE /hostels/:id General: Returns null

Sample: curl -X DELETE http://127.0.0.1:3000/hostels/6370066e0bc496358dba995d

{
    "status": "success",
    "data": null
}

Authentication

POST /singup General: Returns a newly created user.

Sample: curl -d {"name": "Ben Ken", "email": "[email protected]"} http://127.0.0.1:3000/users/signup -H "Content-Type: application/json" -X POST

{
    "status": "success",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6CJ9.eyJpZCI6IjYzNzQ3Z2ODU3OTAyNywzU1MDI3fQ.vill0T-ThQbuA6z5EX1Qg7W8iMqLs",
    "data": {
        "user": {
            "_id": "63747ed2bd9b1e1ab9b89065",
            "name": "Ben Ken",
            "email": "[email protected]",
            "role": "user"
        }
    }
}

POST /login General: Returns JWT token issued to the user.

Sample: curl -d {"email": "[email protected]": "password": "ben123"} http://127.0.0.1:3000/users/login -H "Content-Type: application/json" -X POST

{
    "status": "success",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6CJ9.eyJpZCI6IjYzNzQ3Z2ODU3OTAyNywzU1MDI3fQ.vill0T-ThQbuA6z5EX1Qg7W8iMqLs",
    "data": {
        "user": {
            "_id": "63747ed2bd9b1e1ab9b89065",
            "name": "Ben Ken",
            "email": "[email protected]",
            "role": "user"
        }
    }
}

POST /forgotPassword General: Reset password will be sent to the user's email address.

Sample: curl -d {"email": "[email protected]"} http://127.0.0.1:3000/users/forgotPassword -H "Content-Type: application/json" -X POST

{
    "status": "success",
    "token": "Token sent to email!",
}

PATCH /resetPassword General: Return new password along with user's data.

Sample: curl -d {"password": "test123", "passwordConfirm": "test123"} http://127.0.0.1:3000/users/resetPassword -H "Content-Type: application/json" -X PATCH

{
    "status": "success",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6CJ9.eyJpZCI6IjYzNzQ3Z2ODU3OTAyNywzU1MDI3fQ.vill0T-ThQbuA6z5EX1Qg7W8iMqLs",
    "data": {
        "user": {
            "_id": "63747ed2bd9b1e1ab9b89065",
            "name": "Ben Ken",
            "email": "[email protected]",
            "role": "user"
        }
    }
}

PATCH /updatePassword General: Return updated user's data.

Sample: curl -d {"passwordCurrent": "abeeb1234", "password": "test123", "passwordConfirm": "test123"} http://127.0.0.1:3000/users/resetPassword -H "Content-Type: application/json" -X PATCH

{
    "status": "success",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6CJ9.eyJpZCI6IjYzNzQ3Z2ODU3OTAyNywzU1MDI3fQ.vill0T-ThQbuA6z5EX1Qg7W8iMqLs",
    "data": {
        "user": {
            "_id": "63747ed2bd9b1e1ab9b89065",
            "name": "Ben Ken",
            "email": "[email protected]",
            "role": "user"
        }
    }
}

User Resources

GET /users General: Returns all users.

Sample: curl http://127.0.0.1:3000/users/

{
    "status": "success",
    "results": 4,
    "data": {
        "users": [
            {
                "role": "admin",
                "_id": "637674e56e9820a7ae54f419",
                "name": "Samuel Adebayo",
                "email": "[email protected]",
                "__v": 0,
                "passwordChangedAt": "2022-11-17T18:24:11.658Z"
            },
            {
                "role": "admin",
                "_id": "6376b57a36a6f2ef3b948abc",
                "name": "Opeyemi Surajudeen",
                "email": "[email protected]",
                "__v": 0
            },
            {
                "role": "hostel-owner",
                "_id": "6378bea3c1e56e7246474ec5",
                "name": "Arafims",
                "email": "[email protected]",
                "__v": 0
            },
            {
                "role": "care-taker",
                "_id": "6378c0de2f1d087476b512ee",
                "name": "Hostel management company",
                "email": "[email protected]",
                "__v": 0
            }
        ]
    }
}

GET /users/:id General: Returns user based on id.

Sample: curl http://127.0.0.1:3000/users/63747ed2bd9b1e1ab9b89065

{
    "status": "success",
    "data": {
        "user": {
            "role": "user",
            "_id": "637674e56e9820a7ae54f419",
            "name": "Samuel Adebayo",
            "email": "[email protected]",
            "passwordChangedAt": "2022-11-17T18:24:11.658Z"
        }
    }
}

Description: The JWT token generated when user logged in is used to identify the current user. DELETE AND PATCH operation will be perform on the current user.

PATCH /users/updateMe General: Returns updated data.

Sample: curl -d {"name": "Abeeb Raheem"} http://127.0.0.1:3000/users/updateMe -H "Content-Type: application/json" -X PATCH

{
    "status": "success",
    "data": {
        "user": {
            "role": "user",
            "_id": "6376aff5f69835e82183bdeb",
            "name": "Abeeb Raheem",
            "email": "[email protected]",
        }
    }
}

DELETE /users/deleteMe General: Returns null.

Sample: curl http://127.0.0.1:3000/users/deleteMe -H "Content-Type: application/json" -X DELETE

{
    "status": "success",
    "data": null
}