What is this repo ?

This holds the source codes and configurations needed to run the Baret PT API. The API is a case study for the Belajar Berbagi - Sneak Peek Life At Tech Company Workshop. The code here is managed by git. The workshop utilizes git branches to load the appropriate state of the codebase to facilitate the demo and exercise for a given concept.

The App

Please take a look at the docs folder in this repo for explainations of the app

The Workshop

The main purpose of the workshop is to make the participants understand the day-to-day job of a Software Engineer at a Tech Company. I believe in the power of learning by doing. We learn so much more by actually just practicing rather by doing something else. You can think this workshop as a short Software Engineer internship at my company AdnanCoWorks :D

The workshop consists of demo and exercises. The instructor will demonstrate a concept. Once the participants understood it. The participants are challenged to complete an exercise related to the concept.

The concepts are the hard skills most used by a Software Engineer during day-to-day job. Which are:

1. Understanding requirement + development
2. Testing
3. Documentation
4. Bug Fixing
5. Deployment

Enough reading, let's get our hands dirty!

Preparation

Setup repo

To setup the repo for development please do:

1. In terminal, run yarn install
2. In terminal, run yarn dev

If everything works, the development server should not throw any error

API Documentation

Please follow this step to prepare the coding environment for the workshop:

1. In Sidebar click the Thunder Client button
2. Click Env in the appeared Thunder Client menu
3. Click the filter button
4. Import env variables, Development.postman_environment.json
5. Click Collections in the Thunder Client menu
6. Click the filter button
7. Import collection, Baret API.postman_collection.json

Understanding Requirement + Development

Understanding requirement is a crucial part of a life as a Software Engineer. Because all software starts from defining the requirement of it. Misunderstanding in this step will lead in many errors along the next steps of developing a software

Development is an act of translating requirements into code that can be used (once deployed) by humans and/or other services. Backend is more about the latter. Backend services the Frontend

Create Exercise Requirement:

• this is a protected route. only user that is logged in can use it
• can only create exercise on existing contract
• set exercise status of the created exercise to ACTIVE
• set the start time of the created exercise to the current time
• return the created exercise as success response

Change Password Requirement:

• this is a protected route. only user that is logged in can use it
• validate password properly
• the new password must be encrypted before saving it to the database
• return user information as success response
• make sure no sensitive information in the success response

Instructor Demo: create exercise endpoint Participant Challenge: change password endpoint

Demo Start Git Branch: git checkout 1-demo-requirement-dev-start Demo Solution Git Branch: git checkout 1-demo-requirement-dev-solution

Exercise Start Git Branch: git checkout 1-exercise-requirement-dev-start

Exercise Solution Git Branch: git checkout 1-exercise-requirement-dev-solution

PS: Search the code repository for WORKSHOP-HINT: to help you out during the exercise

Testing

Testing is the act of making sure our code works as expected

Instructor Demo: create an integration testing for create exercise endpoint Participant Challenge: create an integration testing for change password endpoint

Demo Start Git Branch: git checkout 2-demo-testing-start Demo Solution Git Branch: git checkout 2-demo-testing-solution

Exercise Start Git Branch: git checkout 2-exercise-testing-start Exercise Solution Git Branch: git checkout 2-exercise-testing-solution

PS: Search the code repository for WORKSHOP-HINT: to help you out during the exercise

Documentation

Documentation is the act of having a form of media that explains the stuff needed for other Software Engineers to be able understand fully a piece of code. You can see the documentation by importing to Postman:

1. Baret API.postman_collection.json
2. Development.postman_environment.json

Instructor Demo: show complete documentation of Baret PT API

Deployment

Deployment is the act of making our code ready to be used by humans and/or other services

Steps to deploy Deployment can be done in any platform that supports node.js runtime or supports docker deployment. to simplify things, deployment is going to be done in render.com:

1. Register to render.com
2. Create node.js service
3. Create postgres database service
4. Change DATABASE_URL env on node.js service

Instructor Demo: deploy create exercise endpoint changes Participant Challenge: deploy change password endpoint changes

Bug Fixing

Bug fixing is the act of writing code to fix a unexpected behaviour of existing code

Instructor Demo: bug fix in create exercise endpoint