1
Read the overview
Understand what Shipwide is, how its four parts fit together, and the mental model behind the codebase.
2
Run the quickstart
Get all four parts — API, app, admin panel, and website — running on your machine in a few minutes.
3
Configure for your product
Set your environment variables, connect your services, and wire the parts together for your use case.
4
Deploy
Ship each part to production using the deployment guides for your target platform.
Quickstart
Run all four parts locally in a few minutes.
Architecture
How the parts connect and the wire contract they share.
Configuration
Every environment variable, per part, and the wiring that must agree.
Deployment
Ship each part to production.