Merge branch 'main' into typescriptmodule

Author: Shrreya

README.md

@@ -1 +1,94 @@
-# curriculum-backend-readings
+# Backend Curriculum Readings
+This serves as a content monorepo for all the readings of the backend bootcamp curriculum developed by Re:Coded. Content from this repo will be transferred to the course on Canvas LMS. Each markdown file inside the module folders and sub-folders corresponds to a reading on the LMS.
+
+## Folder Structure
+```
+.
+│   README.md                       // We are here   
+│
+└───module1-introduction-to-backend
+|   └───assets                      // common assets folder for module
+│   └───r1-introduction-to-backend
+|       | README.md                 // reading content goes here
+│   └───r1.1-beginners-guide-nodejs-npm
+|       | README.md
+|   └───r2-http-and-rest
+|       | README.md
+|   └───r2.1-diving-into-rest-apis
+|       | README.md
+|   └───...                         // and so on
+|
+└───module2-databases
+|   └───assets                      // common assets folder for module
+│   └───r1-introduction-to-databases
+|       | README.md                 // reading content goes here
+│   └───r2-introduction-to-relational-databases
+|       | README.md
+|   └───r2.1-relational-database-structure
+|       | README.md
+|   └───...                         // and so on
+|
+└───...                             // and so on
+```
+
+## Folder Naming Conventions
+
+- For every new reading, name the folder as: `r[number]-name-of-reading`. For example, `r1-introduction-to-backend` or `r2.1-relational-database-structure`.
+- Use your discretion to shorten certain folder names if required while maintaining the same meaning. For example, the folder for "Beginners guide to Node.js and NPM" can be named as `r1.1-beginners-guide-nodejs-npm`.
+
+## Reading Format
+
+- Each reading should begin with the title as an h1.
+- Below the title it should have the summary and learning goals.
+- After this goes in the main content of the reading.
+- Finally each reading should conclude with a section called References, where we can link the external blogs/tutorials/videos we referred to.
+
+## General Formatting Conventions
+
+- Use proper header hierarchy (h1 # to h6 ######) to convey the flow of topics and sub-topics.
+- Use code and syntax highlighting for code blocks and referring variable/function names.
+- Use tables and lists for non-code content blocks.
+- Always share links through inline links. For example, check out [this markdown cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) is preferred over check out this markdown cheatsheet: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet 
+- Make sure to run your content through [Grammarly](https://www.grammarly.com/) to get rid of typos and grammatical errors.
+
+
+## Peer Review Process
+- Work on a module or reading on it's own branch and open a PR into main branch.
+- Request at least 2 reviewers on your PRs.
+- Open draft PRs early for large modules to get continuous peer reviews. This helps your peers know that the PR is still WIP and is also helpful to review the content in chunks.
+
+## Example
+
+`Start with a H1 for the title`👇
+# Beginners guide to Node.js and NPM
+`Enter a quick summary and numbered list of learning objectives`👇<br/>
+We will be working in the Node.js and NPM environment throughout this bootcamp. The objectives of this lesson are:
+1. Understanding the Node.js framework
+2. Advantages of Node.js and why this course is focussed on Node.js
+
+`Detail out first sub-topic under a H2`👇
+## Introduction to Node.js
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+`Detail out further sections with H3 inside the sub-topic`👇
+### Features of Node.js
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+1. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+2. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+3. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+`Detail out next sub-topic under a H2`👇
+## Why are we teaching Node.js in this bootcamp?
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+`Use the end space of last section for a quick outro or recap of the reading.`👇<br/>
+Now that you have enough context on Node.js, let's prepare our coding environments on our computers. Coming up next is your first assignment of this course which will walk you through setting up your Node.js environment.
+
+`End with a horizontal rule and list References under an H2`👇
+
+---
+## References
+- https://www.freecodecamp.org/news/what-is-npm-a-node-package-manager-tutorial-for-beginners/
+- https://nodejs.dev/learn/introduction-to-nodejs
+- https://medium.com/jspoint/how-javascript-works-in-browser-and-node-ab7d0d09ac2f
+- https://www.geeksforgeeks.org/top-8-reasons-to-learn-nodejs-in-2020/

make_structure.py

@@ -0,0 +1,52 @@
+"""
+This script takes tab delimited input file like so and automatically
+creates the folder structure for readings along with empty README files, per the
+contributing guidelines. If you copy-paste from Google sheets, it will
+automatically add tabs.
+
+Sorry, didn't feel like handling labs, so you just need to delete the lab folder
+when it gets created or rename it manually.
+
+* Copy-paste the file below into `outline.txt` (too lazy to parameterize this
+script) in the directory of the module that you want to use, i.e.,
+`module5-testing/outline.txt`
+* cd to the correct directory (this step is important for the working directory
+to be correct)
+* Run `python3 ../make_structure.py` (not python2)
+* Enjoy your created structure
+
+1	What is a test?
+1.1	Why testing is important?
+2.1	Test-driven development
+2.2	Example code
+2.3	Properties of a good test
+3	Types of tests
+3.1	Popular testing libraries for JavaScript 
+4	Testing lab
+"""
+import subprocess
+import string
+import sys
+import os
+
+# https://stackoverflow.com/questions/265960/best-way-to-strip-punctuation-from-a-string
+def remove_punctuation(s):
+  return s.translate(str.maketrans('', '', string.punctuation))
+
+def main():
+  with open('outline.txt', 'r') as f:
+    text = f.read().strip().strip('\n')
+    module_lines = text.split('\n')
+    for line in module_lines:
+      chapter_num, chapter_name = line.split('\t')
+      
+      # Convert casing: "Example code" to "example-code"
+      normalized_chapter_name = remove_punctuation(chapter_name).replace(' ', '-').lower()
+      # Make directories
+      dir_name = "r" + chapter_num.strip() + '-' + normalized_chapter_name.strip()
+      subprocess.run(["mkdir", "-p", os.path.join(os.getcwd(), dir_name)])
+      # Make README files
+      subprocess.run(["touch", os.path.join(os.getcwd(), dir_name, "README.md")])
+
+if __name__ == '__main__':
+  main()

module1-introduction-to-backend/README.md

@@ -1 +1,40 @@
-# curriculum-backend-readings
+# Module 1: Introduction to Backend
+
+Last Revised: 14/10/2021
+
+## Summary
+Writing backend code requires an intimate understanding of REST and the request-response lifecycle. Students learn how to build and run a local server with API endpoints
+using Node.js and Express.js, handle GET, POST, and other HTTP requests, perform
+validations and return a response.
+
+## Outline
+
+1 [Introduction to Backend [R]](../module1-introduction-to-backend/r1-introduction-to-backend/README.md)
+    
+1.1 [Beginners guide to Node.js and NPM [R]](../module1-introduction-to-backend/r1.1-beginners-guide-nodejs-npm/README.md)
+    
+1.2 [Getting started with Node.js [L]](../module1-introduction-to-backend/r1.2-getting-started-with-nodejs/README.md)
+    
+2 [HTTP and REST [R]](../module1-introduction-to-backend/r2-http-and-rest/README.md)
+    
+2.1 [Diving into REST APIs [R]](../module1-introduction-to-backend/r2.1-diving-into-rest-apis/README.md)
+    
+2.2 [Testing APIs with Postman [L]](../module1-introduction-to-backend/r2.2-testing-apis-with-postman/README.md)
+    
+3 [Introduction to Express.js [R]](../module1-introduction-to-backend/r3-introduction-to-expressjs/README.md)
+    
+3.1 [Express.js Meme Website [L]](../module1-introduction-to-backend/r3.1-expressjs-meme-website/README.md)
+
+3.2 [Express.js Meme API [L]](../module1-introduction-to-backend/r3.2-express.js-meme-api/README.md)
+
+4 [API best practices [R]](../module1-introduction-to-backend/r4-api-best-practices/README.md)
+    
+4.1 [Server-side Validation [R]](../module1-introduction-to-backend/r4.1-server-side-validation/README.md)
+    
+4.2 [Server-side Validation Practice [L]](../module1-introduction-to-backend/r4.2-server-side-validation-practice/README.md)
+
+5 [API Documentation [R]](../module1-introduction-to-backend/r5-api-documentation/README.md)
+    
+5.1 [API Documentation using Swagger [L]](../module1-introduction-to-backend/r5.1-api-documentation-swagger/README.md)
+    
+6 [Summary [R]](../module1-introduction-to-backend/r6-summary/README.md)