Skip to content

Latest commit

 

History

History
110 lines (68 loc) · 5 KB

readme.md

File metadata and controls

110 lines (68 loc) · 5 KB
Raw

Week 1 homework

This homework will result in 2 pull requests:

  • A pull request for the Warmup - in your regular hyf-homework repository
  • A pull request for the Meal-sharing endpoints - in the new meal-sharing repository

Meal-sharing repository

Go to the meal-sharing-template repo and create your own personal repo with the name meal-sharing.
You should now have a meal-sharing repository here: https://github.com/YOUR_GITHUB_USER_NAME/meal-sharing like https://github.com/benna100/meal-sharing. Clone that repository down locally.

Branch

For us mentors to easily give feedback on your code, create all functionality in a PR just like we do normally with homework, so:

  • git checkout -b nodejs-week1 <- in the meal-sharing repo you have cloned down.
  • Make your code in the nodejs-week1 branch and when you are done create a PR with the nodejs-week1 branch.

Warmup

In your hyf-homework repository, nodejs/week1 directory, create a file named avg.js which will calculate the average of the numbers provided as command line arguments.

But what are command line arguments? The arguments you provide to a command line program. Here's an example of how we would invoke avg.js with 3 numbers:

$ node avg.js 13 7 4
8

Hint: read to see how we can deal with command line arguments.

Optional improvements and considerations:

  • What should happen if the provided arguments are not numbers (node avg.js 1 two hello 4)?
  • What about if no arguments are provided (node avg.js)?

Meal sharing endpoints

You will begin working in the meal-sharing repository for this homework and continue throughout the whole Node.js module. Each week you will build upon the endpoints, resulting in the backend setup for your future meal sharing website.

Setup

The meal-sharing-template README has further instructions on how to set up and run this locally but the key steps are summarized here:

  • Run npm install to install all the needed NPM packages.
  • Create .env by copying the existing .env.example file. Update DB_USER, DB_PASSWORD, etc. so the server can successfully establish the connection to the database.
  • Run npm run server to start the server.

Database

In the Database module, we worked on the meal sharing database. The diagram for that database can be found here.

In this homework, we will reuse the same database schema and build a web server with the following routes.

Getting started

The routes you need to implement as part of this homework should go into /src/backend/app.js after the line where it says router.use("/meals", mealsRouter);. There you can go ahead and define the desired routes like you normally would:

app.get("/my-route", (req, res) => {
  res.send("Hi friend");
});

Routes

Route Description
/future-meals Respond with all meals in the future (relative to the when datetime)
/past-meals Respond with all meals in the past (relative to the when datetime)
/all-meals Respond with all meals sorted by ID
/first-meal Respond with the first meal (meaning with the minimum id)
/last-meal Respond with the last meal (meaning with the maximum id)

Responses

All the specified routes should respond with JSON with the available columns from the meal table.

Multiple meals: /future-meals, /past-meals and /all-meals are expected to respond with a collection of meals, meaning an array of objects.

Single meal: The other 2 routes, /first-meal and /last-meal, are expected to respond with a single meal, meaning an object.

What if there are no meals?: /first-meal and /last-meal should in that case return a 404 response with an explanation that there are no meals. The other routes should in that case just return an empty array.

Knex

Our usage of Knex will get more advanced over the coming weeks but for now, we will focus on the simplified knex.raw function that can execute a raw SQL query. Example:

knex.raw("SELECT VERSION()").then(() => {
  console.log(`connection to db successful!`);
});

Note: SELECT VERSION() is a valid MySQL query but you would probably do something like this SELECT * FROM some_table.

Also, knex.raw returns a Promise so you can also use the async/await syntax.


Hand in homework

Need to brush up on the homework hand-in process?
Check this resource to remember how to hand in the homework correctly!