https://github.com/gethgr/software-engineer-handbook
Practical guide for common and useful commands for software engineer.
https://github.com/gethgr/software-engineer-handbook
cheatsheet commands handbook mkdocs software-engineering
Last synced: 24 days ago
JSON representation
Practical guide for common and useful commands for software engineer.
- Host: GitHub
- URL: https://github.com/gethgr/software-engineer-handbook
- Owner: gethgr
- Created: 2025-10-30T13:55:03.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-10-30T15:15:17.000Z (9 months ago)
- Last Synced: 2025-10-30T15:33:51.760Z (9 months ago)
- Topics: cheatsheet, commands, handbook, mkdocs, software-engineering
- Homepage: https://gethgr.github.io/software-engineer-handbook/
- Size: 602 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Software Engineer Handbook
## Description
This repository contains a collection of practical cheat sheets and guides for common tools and frameworks used in software engineering. It covers various topics, including Django, PostgreSQL, Pytest, Docker, Git, and more.
Whether you're a beginner or an experienced developer, this handbook provides quick reference commands, workflows, and best practices for everyday tasks.
The content is organized by category to make it easier for you to find what you need.
## Features
- 📜 **Django Commands**: Common commands for managing a Django project.
- 🛠️ **Pytest**: Commands and practices for testing your code.
- 🐳 **Docker**: Useful commands for working with Docker containers.
- ⚙️ **PostgreSQL**: Commands for database management and operations.
- 🐦 **Git & GitHub**: Best practices and common commands for version control.
## Live Demo
You can view the live version of this handbook on GitHub Pages:
[Visit the Handbook](https://gethgr.github.io/software-engineer-handbook/celery/)
## Installation
To install and contribute to this repository:
- Clone the repository:
```bash
git clone https://github.com/gethgr software-engineer-handbook/tree/main
```
- Install the required dependencies with Poetry:
```bash
poetry install
```
- Build the documentation static files:
```bash
poetry run mkdocs build
```
- To run the site locally:
```bash
poetry run mkdocs serve
```
### Contributing
If you find any issues or want to suggest new additions, feel free to open an issue or create a pull request.