| title | Getting Started |
|---|---|
| description | From clone to running app to first contribution |
| audience | developer |
git clone https://github.com/jermbo/SampleAPIs.git
cd SampleAPIs
npm install && npm install --prefix server && npm install --prefix client
npm run devServer at http://localhost:5555, site at http://localhost:4444 — details in Local Development.
- New to the system? Read the System Overview first (2 minutes)
- Working on data? Endpoint JSON Format and Adding an Endpoint
- Working on the site? Client Features
- Working on the server? Request Lifecycle and API Surface
The most valued contribution is new or improved datasets — the project exists to give learners interesting data to play with. Process-wise, start with an issue before you code (see Pull Request Flow).