ReCoded-Org / curriculum-backend-readings

Content monorepo for all the readings of the backend bootcamp curriculum developed by Re:Coded.
23 stars 4 forks source link

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

Reading Format

General Formatting Conventions

Peer Review Process

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👇
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.👇
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