Skip to content

Commit

Permalink
docs: clarify what is needed to get started (#136)
Browse files Browse the repository at this point in the history
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!
  • Loading branch information
olizilla authored Feb 14, 2023
1 parent 46ae012 commit 3101b43
Showing 1 changed file with 22 additions and 9 deletions.
31 changes: 22 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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://<pr#>.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://<pr#>.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).
Expand Down Expand Up @@ -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
[upload-client]: https://www.npmjs.com/package/@web3-storage/upload-client

0 comments on commit 3101b43

Please sign in to comment.