node_modules/
data/
    --- migrations/
        --- createUsersTable.js
        --- createPotlucksTable.js...
    --- seeds/
        --- 01Users.js
        --- 02Potlucks.js...
    --- dev.sqlite3
    --- testing.sqlite3
    --- db.js
models/
    --- users.js
    --- potlucks.js...
routes/
    --- index.js
    --- users.js
    --- potlucks.js...
controllers/
    --- users.js
    --- potlucks.js...
middleware/
    --- auth.js
server.js
index.js
knexfile.js
.env

"Welcome to the API"

{
    username,
    password
}

{
    token: jwtToken,
    message: "Welcome username"
}

{
    email,
    username,
    password,
    location (optional),
    pfp (optional)
}

{
    token: jwtToken,
    message: "Your account was created"
}

{
    users: [
        {
            id: user's id,
            email: user's email,
            username: user's username,
            pfp: user's profile pic,
            location: user's location
        }...
    ]
}

{
    user: {
        id: user's id,
        username: user's username,
        email: user's email,
        pfp: user's profile pic,
        location: user's location,
        potlucks: [
            {
                potluckId: potluck's id,
                title: potluck's title,
                organizerId: organizer's id,
                when: datetime of when potluck will take place
                location: potluck's location
            }...
        ]
    }
}

{
    username (optional),
    email (optional),
    password (optional),
    location (optional),
    pfp (optional)
}

{
    message: "Your account info was updated",
    user: {
        id
        username,
        email,
        password,
        location,
        pfp
    }
}

{
    message: "Your account was deleted,
    user: {
        id,
        username,
        email,
        password,
        location,
        pfp
    }
}

[
    {
        id,
        organizerId,
        title,
        when,
        location
    }...
]

{
    title,
    when,
    location,
    items: [
        "itemName"
        ...
    ]
}

{
    message: "Potluck created",
    potluck: {
        id,
        organizerId,
        title,
        when,
        location,
        items: [
            {
                id,
                name,
                guestResponsible,
                potluckId
            }...
        ]
    }
}

{
    potluckId,
    title,
    when,
    location,
    organizerId,
    organizerUsername,
    organizerPfp,
    organizerLocation,
    items: [
        name,
        potluckId,
        guestUsername,
        guestId,
        guestPfp,
        guestLocation
    ],
    guests: [
        {
            id,
            username,
            pfp,
            location
        }
    ]
}

{
    title,
    when,
    location,
    items: [
        "itemName",
        ...
    ]
}

{
    potluckId,
    title,
    when,
    location, 
    organizerId,
    organizerUsername,
    organizerPfp,
    organizerLocation,
    items: [
        {
            name,
            potluckId,
            guestUsername,
            guestId,
            guestPfp,
            guestLocation
        }...
    ],
    guests: [
        {
            id,
            username,
            pfp,
            location
        }...
    ]
}

{
    message: "Your potluck was deleted",
    potluckToDelete: {
        id,
        organizerId,
        title,
        when,
        location
    }
}

[
    {
        name,
        potluckId
    }
]

{
    name,
}

"[item's name] added"

{
    name,
}

{
    message: "Item updated"
}

{
    message: "You have removed this item from the potluck"
}

[
    {
        title,
        username,
        id
    }...
]

[
    {
        title,
        username,
        id
    }...
]

{
    id (the guest's id),
    username
}

"[guests username] successfully invited"

{
    status: (-1 for decline, 1 for accept)
}

when accepted
{
    message: "Congrats - you are on the guestlist"
}

when declined
{
    message: "Hope to see you at the next one!"
}

{
    message: "You have been removed from the guestlist of this potluck"
}

{
    title,
    username,
    potluckId
}

{
        message: "Guest successfully removed from guestlist"
}