This is the backend challenge.

NodeJS >= 8.9.4 Windows x64 or Unix Connection to internet.

Clone the repository and install all the dependencies with:

yarn

After that, rename the .env.example file to .env. I've already defined the database values because I'm using Mongo Atlas to host the project, I had no time to configure it on localhost ;).

Just run the following commands to run on development mode:

yarn dev

It will run a instance of ts-node with nodemon. It will refresh automatically the project if a change have been detected.

This project have been designed to be used with typescript. You can use ts-node or the default node instance by running the following command to compile the project.

yarn dist

And then run:

node -r dotenv/config ./dist/server.js

I've decided to split the project into two services: Mongo and Express. I've turned it into a promise, because when the server is bootstrapping, it will only start the express service only if a connection is stablished to the Mongo database. Both are running by separated instances.

The endpoints are considered as modules, because it will be much more easier to maintain and find them on their own folder.

The folder architecture on modules must be | module-name | --> controllers | --> models | --> module-name.route.ts

The controllers folder will contain all the business logic for the specified module. The models folder will contain the Mongo typegoose model. The module-name.route.ts will contain the routes to be accessed by the defined endpoint.

All endpoints are respective to a restaurant.

The header Content-Type must be:

The routes does not have an authentication functionality.

All post content must be a valid JSON and should be submitted as a body content.

Restaurant Model

IWorkingDays Model

Example JSON:

{
    "name": "Doces da vovó",
    "address": "Rua XV, 15",
    "photo": "https://url.com/a.png",
    "activityDate": [
        {
            "dayOfWeek": "monday-friday",
            "times": {
                "start": "08:00",
                "end": "18:15"
            }
        },
        {
            "dayOfWeek": "saturday-sunday",
            "times": {
                "start": "10:00",
                "end": "14:30"
            }
        }
    ]
}

All categories routes are available after a valid restaurant id. For example: /restaurants/:id/categories

Category Model

Example json:

{
    "restaurantId": "123",
    "name": "Sodas"
}

All products routes are available after a valid restaurant id. For example: /restaurants/:id/products

Product Model

IProductPromotion

Example json:

{
    "name": "Coca-Cola",
    "category": "generated category id",
    "price": 10.99,
    "photo": "http://url.com/a.png",
    "promotion": {
        "description": "Coke for 1.99",
        "price": 1.99,
        "days": [
            {
                "dayOfWeek": "monday",
                "times": {
                    "start": "10:00",
                    "end": "12:00"
                }
            },
            {
                "dayOfWeek": "sunday",
                "times": {
                    "start": "09:00",
                    "end": "09:15"
                }
            }
        ]
    }
}

Todo.

Lucas Reis Máximo Dias - [email protected]