https://github.com/aburd/backend_engineering_handbook
A series of articles meant to serve as a concise handbook to backend engineering
https://github.com/aburd/backend_engineering_handbook
Last synced: 6 months ago
JSON representation
A series of articles meant to serve as a concise handbook to backend engineering
- Host: GitHub
- URL: https://github.com/aburd/backend_engineering_handbook
- Owner: aburd
- License: gpl-3.0
- Created: 2022-10-17T08:05:46.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-19T00:33:07.000Z (over 3 years ago)
- Last Synced: 2025-05-24T01:38:48.608Z (about 1 year ago)
- Size: 19.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# The Backend Engineering Handbook
This repository will be primarily a series of articles meant to serve as a concise handbook to backend engineering. The structure of it is based on the roadmap.sh's popular [Backend Roadmap](https://roadmap.sh/backend). The reason for this repository is that while roadmap.sh's guide is wonderful:
- It's collaborative nature means the writing style is not necessarily consistent
- As user submissions are accepted, and information is numerous
I would like to provide a cohesive set of articles that can be read front to back to a reader who would like a general overview of the subject.
## Structure
The bulk of this repository will be in the /markdown directory. Each article will be numbered.
Any static supplementary material (i.e. images) should be in the /public directory.
Any dynamic material (i.e. web-application, demo) should be in the /src directory.
## Style
### Overall
This material is meant to be concise and accessible. Think " for Dummies".
It is not meant to be highly detailed, supplementary material will be provided to the reader for futher reading.
If the material is very technical, it should part of later sections after the reader has built some understanding.
### Articles
Articles are meant to be read in succession, however, each article should stand on its own for readers who just need a quick reference on a subject.
Each article:
- should begin with an introduction
- should take no more than 15 minutes to read for someone familiar with the material, and no more than 30 minutes to read for someone who maybe new to the subject.
- should provide a summary for readers to structure the topic in their mind
- should provide some extra material for those who require more detailed reading.
## Corrections/Submissions/Questions
Feel free to submit an issue or PR if you find any mistakes, inquiries, etc.