mirror of
https://github.com/LukeMathWalker/zero-to-production.git
synced 2024-12-11 18:46:33 +00:00
Update README.
This commit is contained in:
parent
632812cf48
commit
f2103c2720
1 changed files with 60 additions and 9 deletions
69
README.md
69
README.md
|
@ -1,29 +1,74 @@
|
||||||
# Zero To Production / Code (Chapter 4)
|
# Zero To Production In Rust
|
||||||
|
|
||||||
<div align="center"><a href="https://zero2prod.com" target="_blank"><img src="https://static-2.gumroad.com/res/gumroad/3629854790655/asset_previews/bc9026cad3ece1746327c1d70218f602/retina/rsz_zero_to_production_punk.png" /></a></div>
|
<div align="center"><a href="https://zero2prod.com" target="_blank"><img src="https://www.zero2prod.com/assets/img/zero2prod_banner.webp" /></a></div>
|
||||||
|
|
||||||
[Zero To Production In Rust](https://zero2prod.com) is an opinionated introduction to backend development using Rust.
|
[Zero To Production In Rust](https://zero2prod.com) is an opinionated introduction to backend development using Rust.
|
||||||
|
|
||||||
This repository serves as supplementary material for [the book](https://zero2prod.com/): it hosts snapshots of the codebase of our email newsletter project at end of each chapter.
|
This repository serves as supplementary material for [the book](https://zero2prod.com/): it hosts several snapshots of the codebase for our email newsletter project as it evolves throughout the book.
|
||||||
|
|
||||||
**This branch is a snapshot of the project at the end of Chapter 4.**
|
## Chapter snapshots
|
||||||
|
|
||||||
## Pre-requisite
|
The [`main`](https://github.com/LukeMathWalker/zero-to-production) branch shows the project at the end of the book.
|
||||||
|
|
||||||
|
You can browse the project at the end of previous chapters by switching to their dedicated branches:
|
||||||
|
|
||||||
|
- [Chapter 3, Part 0](https://github.com/LukeMathWalker/zero-to-production/tree/root-chapter-03-part0)
|
||||||
|
- [Chapter 3, Part 1](https://github.com/LukeMathWalker/zero-to-production/tree/root-chapter-03-part1)
|
||||||
|
- [Chapter 4](https://github.com/LukeMathWalker/zero-to-production/tree/root-chapter-04)
|
||||||
|
- [Chapter 5](https://github.com/LukeMathWalker/zero-to-production/tree/root-chapter-05)
|
||||||
|
- [Chapter 6, Part 0](https://github.com/LukeMathWalker/zero-to-production/tree/root-chapter-06-part0)
|
||||||
|
- [Chapter 6, Part 1](https://github.com/LukeMathWalker/zero-to-production/tree/root-chapter-06-part1)
|
||||||
|
- [Chapter 7, Part 0](https://github.com/LukeMathWalker/zero-to-production/tree/root-chapter-07-part0)
|
||||||
|
- [Chapter 7, Part 1](https://github.com/LukeMathWalker/zero-to-production/tree/root-chapter-07-part1)
|
||||||
|
- [Chapter 7, Part 2](https://github.com/LukeMathWalker/zero-to-production/tree/root-chapter-07-part2)
|
||||||
|
- [Chapter 8](https://github.com/LukeMathWalker/zero-to-production/tree/root-chapter-08)
|
||||||
|
- [Chapter 9](https://github.com/LukeMathWalker/zero-to-production/tree/root-chapter-09)
|
||||||
|
- [Chapter 10, Part 0](https://github.com/LukeMathWalker/zero-to-production/tree/root-chapter-10-part0)
|
||||||
|
- [Chapter 10, Part 1](https://github.com/LukeMathWalker/zero-to-production/tree/root-chapter-10-part1)
|
||||||
|
- [Chapter 10, Part 2](https://github.com/LukeMathWalker/zero-to-production/tree/root-chapter-10-part2)
|
||||||
|
- [Chapter 10, Part 3](https://github.com/LukeMathWalker/zero-to-production/tree/root-chapter-10-part3)
|
||||||
|
- [Chapter 11](https://github.com/LukeMathWalker/zero-to-production/tree/root-chapter-11)
|
||||||
|
|
||||||
|
## Pre-requisites
|
||||||
|
|
||||||
You'll need to install:
|
You'll need to install:
|
||||||
|
|
||||||
- [Rust](https://www.rust-lang.org/tools/install)
|
- [Rust](https://www.rust-lang.org/tools/install)
|
||||||
- [Docker](https://docs.docker.com/get-docker/)
|
- [Docker](https://docs.docker.com/get-docker/)
|
||||||
|
|
||||||
|
There are also some OS-specific requirements.
|
||||||
|
|
||||||
|
### Windows
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cargo install -f cargo-binutils
|
||||||
|
rustup component add llvm-tools-preview
|
||||||
|
```
|
||||||
|
|
||||||
|
### Linux
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Ubuntu
|
||||||
|
sudo apt-get install lld clang
|
||||||
|
# Arch
|
||||||
|
sudo pacman -S lld clang
|
||||||
|
```
|
||||||
|
|
||||||
|
### MacOS
|
||||||
|
|
||||||
|
```bash
|
||||||
|
brew install michaeleisel/zld/zld
|
||||||
|
```
|
||||||
|
|
||||||
|
## How to build
|
||||||
|
|
||||||
Launch a (migrated) Postgres database via Docker:
|
Launch a (migrated) Postgres database via Docker:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./scripts/init_db.sh
|
./scripts/init_db.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
## How to build
|
Launch `cargo`:
|
||||||
|
|
||||||
Using `cargo`:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cargo build
|
cargo build
|
||||||
|
@ -31,7 +76,13 @@ cargo build
|
||||||
|
|
||||||
## How to test
|
## How to test
|
||||||
|
|
||||||
Using `cargo`:
|
Launch a (migrated) Postgres database via Docker:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/init_db.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
Launch `cargo`:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cargo test
|
cargo test
|
||||||
|
|
Loading…
Reference in a new issue