Sherpa° Coding Challenge

This repo represents my WIP attempt at the Sherpa BE coding challenge. Features:

Sequelize ORM
- Data loaded using Sequelize migrations & seeders (see scripts in /package.json)
OpenAPI 3.0 spec in docs/openapi.yaml
Swagger UI:

Run npm start
Browse to localhost:4040/api-docs
Try it out. Any text will pass as the token.

Missing/TODO

Pagination: next_cursor isn't fully implemented
Call weather API
Directory structure needs cleanup
Manual copy of myDb.sqlite current required after migrations (npm run deployDatabase)
TypeScript. openapi-generator-cli doesn't have a server generator for TypeScript, so is currently es6
Tests

Original README Below

Introduction

Hi! If you're reading this then it's because you're in the interview process with us at sherpa° and have been invited to complete the coding challenge. Congratulations!

This coding challenge is designed to assess your ability while giving you the freedom to express yourself and show off what you consider to be best practices.

Setup

This repo contains the skeleton of an express app in typescript, to which you will add functionality. The code here was built for node version 14.

The first step is to run npm i to install the required dependencies.

A handful of scripts are provided, npm run build will build the application, npm run start will start the application, npm run test will run the tests.

The last script generateData should be executed in order to populate a json file at data/data.json this is required because it is necessary that the data have dates that are in the near future.

The scenario

You are a developer at a consulting company to work on a brand-new project, requirement is to build an application to service an events management company.

Currently, everything is being managed by hand and this is proving unwieldy. The first step of the first iteration of the solution is to build a REST api to perform CRUD operations on events.

Requirements

The Data

Determine how to model the data. The clients have provided a sample of their data in data/data.json. Your project manager has told you that they have events, events have a location, a name, and an organizer, who is a member of staff responsible for the event. You also know that there will be a need to associate a list of invitees with events, along with their rsvp status.

Derive a data model for this relation of entities. Create the tables in the sqlite database, you may want to think about maintainability and documentation, an ERD might be useful, as might a migration process, you may want to think about using an ORM.

The data given to you by the clients is a sample of the data as you expect to receive it. When the time comes they will provide a large json file to import into the db.

Import the sample data into the database, write a script to do this and bear in mind it must operate at scale. You should think about data integrity, these clients are not tech-savvy, and we don't know how this json is being generated

The api

GET /events

Retrieve upcoming events, the endpoint must accept the following query parameters:

from: optional, Date, defaults ot the current time, only return events after this date
until: optional, Date, if omitted return all future events

The required response is:

{
    results: [
        {
            id: <unique identifier of event in our system>,
            name: string,
            date: Date,
            isOutside: boolean
            attandees: [] // empty array is fine for first iteration
            organizer: {
                id: <unique identifier of organizer in our system>,
                name: string
            },
        }
    ]
}

In addition, the results must be paginated, the specifics of the pagination are left up to you to decide.

GET /events/{eventId}

Retrieve details for an upcoming event

{
    id: <unique identifier of event in our system>,
    name: string,
    date: Date,
    isOutside: boolean
    attandees: [] // empty array is fine for first iteration
    organizer: {
        id: <unique identifier of organizer in our system>,
        name: string
    },
    // if an event is outside and occuring withing 7 days, call any weather api to get the following details
    // if an event is not outside, or not occuring within 7 days this should be null
    weather: null || {
        temperatureInDegreesCelcius: number,
        chanceOfRain: number 0-100
    }
    // OPTIONAL: This has been designated a 'nice to to have'
    // if an event is happening in any country other than canada, fetch the visa and proof of vaccination requirements our organizers need
    // the destination would be the country the event is happening in and the source is canada
    // if an event is happening in canada, leave this null
    visaRequirements: null | string
    proofOfVaccineRequired: null | boolean
}

Tips

You have been provided with the barest of bare bones to get started. But don't feel compelled to use what is here, if you prefer hapi to express, or don't want to use any kind of http framework at all, or dislike typescript, you can yank those out and start completely afresh. You won't be judged negatively for it, but if you do make any big decisions it would certainly be a good idea to document why you chose what you chose.

Because the slate is blank, you will be making a lot of decisions about how the app should work, it's a good idea to document these decisions, as you will very likely be asked about them in the follow-up.

The functional requirements here should probably take no longer than a couple of hours to implement. The standard you should be aiming for is something you would submit as a pull request for a production ready feature.

psmacmur / sherpa-backend-coding-challenge