From 3101b43d39c78f8cc0c432eb0a62a5e3865aff6d Mon Sep 17 00:00:00 2001 From: Oli Evans Date: Tue, 14 Feb 2023 09:29:21 +0000 Subject: [PATCH] docs: clarify what is needed to get started (#136) You dont need to configure an aws account locally, you can submit a PR and seed.run will deploy it. Prompted by @travis' experience of getting started with this repo! --- README.md | 31 ++++++++++++++++++++++--------- 1 file changed, 22 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index e5f41b84..3c413870 100644 --- a/README.md +++ b/README.md @@ -24,24 +24,37 @@ The repo contains the infra deployment code and the api implementation. To work on this codebase **you need**: - Node.js >= v16 (prod env is node v16) -- An AWS account with the AWS CLI configured locally -- Copy `.env.tpl` to `.env.local` - Install the deps with `npm i` -Deploy dev services to your aws account and start dev console +You can then run the tests locally with `npm test`. -```console -npm start -``` +To try out a change submit a PR and you'll get temporary infra rolled out for you automatically at `https://.up.web3.storage`. -See: https://docs.sst.dev for more info on how things get deployed. +[`sst`](https://sst.dev) is the framework we use to define what to deploy. Read the docs! https://sst.dev ## Deployment -Deployment is managed by [seed.run]. PR's are deployed automatically to `https://.up.web3.storage`. +Deployments are managed by [seed.run]. The `main` branch is deployed to https://staging.up.web3.storage and staging builds are promoted to prod manually via the UI at https://console.seed.run +### Local dev + +You can use `sst` to create a custom dev deployment on aws, with a local dev console for debugging. + +To do that **you need** + +- An AWS account with the AWS CLI configured locally +- Copy `.env.tpl` to `.env.local` + +Then run `npm start` to deploy dev services to your aws account and start dev console + +```console +npm start +``` + +See: https://docs.sst.dev for more info on how things get deployed. + ## Integration tests Integration tests run by default on post-deploy stage of [seed.run] deployment pipeline. These integration tests will run with the deployed infrastructure for the given stages (PR / staging). @@ -236,4 +249,4 @@ const cid = await uploadFile({ [ucanto]: https://www.npmjs.com/package/ucanto [seed.run]: https://seed.run [w3protocol]: https://github.com/web3-storage/w3protocol -[upload-client]: https://www.npmjs.com/package/@web3-storage/upload-client \ No newline at end of file +[upload-client]: https://www.npmjs.com/package/@web3-storage/upload-client