jjuli93 / node-training

Node.js API template

Bootstrapping

• Read the rest of this README.md
• Follow the Start project section
• Run the tests
• Start the server

After all is setup & running, feel free to remove the local git repository and initialize a new one, rename databases, and remove the sample source code.

Stack

This section is going to show a curated list of the packages and tools used for this project (to see the full list of dependencies take a look at package.json)

• Koa
• Koa Router
• Koa CORS
• Koa Passport
• Koa Bodyparser
• Objection.js
• knex
• Jest
• PostgreSQL
• Docker
• Docker Compose
• Git

Start project

Start project with docker (recommended)

In order to start the project with docker you just need to execute the following script (you should have docker already installed and working on your machine)

./bin/start

The script assumes that you have a .env.sample file that file is going to be copied to a file with the name .env and it's going to be used to start the application

Start project manually

The following files needs to be copied and modified accordingly

$ cp .env.sample .env

After copy those files edit them to have the right values (ask a teammate if you don't know any of those values), then you will need to create the database to do Postres is required to be up and running (if you have it you can avoid the installation instructions for Postgres)

Install tools

PostgreSQL

The easiest way to install postres is using this app, just follow the instructions on their site and you will be ready to go (you might need to reload the terminal to have access to postgres app commands)

Version manager

To install all the tools required by the project you need a tool to manage the version of the tools. Using asdf-vm you can install all the tools, to install it you need to follow the instructions on https://asdf-vm.com/

Node.js

If you want to manage node versions using asdf you need to install a plugin that is able to install the different node versions, to do that just type the following command

$ asdf plugin add nodejs

And then to install nodejs run the following command

$ asdf install nodejs 16.10.0

Install project dependencies

$ yarn install

Create database

Based on the information on the file .env (that you copy previously) create two databases on for test and one for development to do that just run the following command

$ createdb node_template_development
$ createdb node_template_test

Make sure those names matches what you have on .env

Start the project

$ yarn run dev

This command will start a dev server and every change that is made to the code is reflected on the terminal, that is running the code.

By default it will start the server port 3000. If you want to run the server in a different port, update the PORT environment variable

Usage

Migrate and seed database

If you are running the project with docker, first you need to enter to the terminal (inside the container), to do that just type the following command on your shell:

$ ./bin/terminal

Once you are there you can use the following commands to either migrate or seed the database, for none docker users just type the commands directly on the root of the project.

In order to have the latest schema on your database you need to run the following command:

$ yarn migrate:latest

Then to create some seed data for development the following command can be run:

$ npx knex seed:run

Scripts

Code generators

• To generate an entity scaffold: npx hygen generate scaffold
• Make migration: npx hygen generate migration
• Make seed: npx hygen generate seed

Running tests

To run the test just type the following command

$ yarn run test

ESLint & Prettier

To run the linter and fix try to fix issues automatically run the following command

$ yarn run lint -- --fix

Cleanup template files

The template has some example files like models, migrations, and tests for those models once you are comfortable with the template you can execute the following script to clean up the template:

$ ./bin/cleanup

Specific Documentation

• Authentication
• Serializer
• Pagination
• Logging

node-training's Issues

6. Implement first user's endpoint

User's endpoints must check that a valid JWT token comes from the HTTP request.

If JWT token is invalid, user's endpoint should respond with the appropriate response.

A user shouldn't access/modify other users data.

• Get user's lists

2. Node.js scripting

Write and run simple node.js script

Implement a node.js script that receives a regular expression and prints all of the files that whose filename match the given regular expression under the current directory (recursively)

Example

node fs-scan.js '\.js$'

Output

./node_modules/json-schema/test/tests.js
./node_modules/json-schema/lib/links.js
./node_modules/json-schema/lib/validate.js
./src/lib/tron/redux-tron.js

--
References:

• https://nodejs.org/api/fs.html

9. Additional Resources

This card contains a list of additional resources that you might find useful, to follow
your journey in the future.

• Dev.to
• Scrimba
• JavaScript Weekly
• Node.js Weekly

Onboarding: basic

3. Implement the first endpoint of the "moovie" API

• Clone https://github.com/moove-it/node-rest-template and follow bootstrap instructions
• Read the source code of that skeleton project and get a sense of the overall architecture
• Push that codebase to the created repository.
• Implement "Get genres" operation. This includes adding migrations, seeds, models, routes, and tests.

Onboarding: nodejs_scripting

1. Learn REST

Learn the basics about REST (https://restfulapi.net/).

Read the following sections / topics:

• Learn REST (the whole section)
• Idempotence
• Put vs Post

4. Build a node.js tool

Create a tool to list GitHub projects

Implement a node.js tool that given a source GitHub repository, lists the name of the projects and the tasks within those projects.

Format the output in some way that will help a user to see projects and their tasks at a glance.

--
References:

• GitHub REST API v3 / Projects

Onboarding: nodejs_api

1. Install environment

• Install nvm
• Install latest node.js version, using nvm

2. Agile methodologies part 1

Learn about Agile related topics by reading:

• 12 Principles Behind the Agile Manifesto
• The Scrum Guide
• Kanban Guide
• Chapters 4 and 6 from the book Agile Estimating and Planning

Also:

• Check the Agile Glossary and keep it as reference

3. Basics about OS command line

Understand how to use the most used command line tools

• Check the commands here, and keep that reference at hand

8. Implement user's profile endpoints

• Get user profile
• Update user profile
• Upload user photo
• Remove user photo

4. Implement movies endpoints

• List movies (supporting paging, filtering, and sorting)
• Get movie

7. Implement the rest of lists endpoints

• Create list
• Get list
• Update list
• Delete list
• Add movie to list
• Remove movie from list

6. Git practice 1

Learn Git Branching provides a good framework for understanding what is really going on when you merge, rebase, etc.

Complete the following sections of the Main challenges (selected via the "Main" tab in the "Select a level" UI):

• Introduction Sequence
• Ramping Up
• Moving Work Around

Then complete the following section of the Remote challenges (selected via the "Remote" tab in the "Select a level" UI):

• Push & Pull -- Git Remotes!

3. Use a linter

Write code using a consistent style

• Install eslint, prettier, husky
• Configure .eslintignore, .eslintrc.js, and .prettierrc.js
• Configure husky to run the npm run lint on pre-commit
• Run the linter and fix any warnings and errors

9. Final readings

• Commit message style guide
• Guide about code review
• This apprenticeship's README.md for information on how to create Pull Requests in future exercises.
• A Pragmatic Quick Reference

Onboarding: basic

5. Basics about git

Understand how to work with git

• Go through the following introductory git tutorial

Learn about:

• Different file status life cycles
• Git remotes
• Basic commands: add/commit/push

Additional resources:

• Check Pro Git book and keep it as a reference

7. Git workflow

Understand how to use git in a collaborative way and solve common situations faced across a project’s life cycle

• Read Gitflow Workflow

Learn about:

• Feature branches
• Hotfix branches

Onboarding: nodejs_scripting

5. Add authentication

• Investigate about JWT
• Check Authentication section on the template documentation
• Follow the instructions for configuring everything needed and adding a login endpoint
• Write a script to add a user and its credentials to the database

4. Setup your Github account

Get everything ready to start using your Github account

• Follow the steps in Connecting to Github with ssh

Onboardings: node_scripting

Onboarding: basic

8. Git practice 2

• Make the exercises in the web https://gitexercises.fracz.com

1. Initial readings

Start by reading the following resources:

• Moove It's Playbook
• Time tracking during the Onboarding

Also:

• Check Moove It's Knowledge library where we share useful resources on many technical topics

2. Design the "moovie" API

Take a look at this diagram (open it with StarUML):

Based on that model, design an API that supports the following operations:

Movies:

• List movies (supporting paging, filtering, and sorting)
• Get movie

Lists:

• Get user lists
• Create list
• Get list
• Update list
• Delete list
• Add movie to list
• Remove movie from list

Genres:

• Get genres

User profile:

• Get user profile
• Update user profile
• Upload user photo
• Remove user photo

For each one of the above operations, you should specify:

• HTTP method
• HTTP path
• path parameters
• query parameters parameters
• Possible HTTP response codes
• Success response schema
• Error response schema

NOTE: Don't design for authentication / authorization in mind. These topics will be covered later.

5. Extend the tool to filter projects

Add the ability to filter the list of projects to the tool built on the previous task.

Extend the tool to receive an optional parameter, that will be a regular expression. Then list the projects that match that pattern.

--
References:

• GitHub REST API v3 / Projects

Onboardings: basic