Skip to content

Commit

Permalink
includes deployment instructions [readme]
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexandrosGounis committed Dec 5, 2023
1 parent 3126897 commit c928743
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,24 @@
1. Run `yarn` to install dependencies ([install yarn if not available](https://yarnpkg.com/getting-started/install))
2. Run `yarn dev` to start a dev server

## Deploy

Deployments are handled automatically with github actions (see the pipelines in `.github/workflows/`).

Pushing to the `main` branch will update production while pushing to `staging` will update staging:
```perl
push to /main → updates services.kukai.app
push to /staging → updates staging.services.kukai.app
```

## Modify

1. Navigate to the path are looking for (i.e. `/version` corresponds to `<endpoint>/v1/version)
1. Navigate to the path are looking for (i.e. `/version` corresponds to `<endpoint>/v1/version`)
2. Navigate to the `storage` folder, modify the `.json` file
3. Test locally with `yarn dev` (i.e. `localhost:8787/v1/version`)

## Deploy

1. Make sure you have `npm` installed, this comes with the `npx` package manager
2. Run `npx wrangler login`
3. Run `npx wrangler publish --env staging` for deploying your changes to the `staging` environment. (See `wrangler.toml` for more options)

Use `--env production` to deploy to production, or skip the `--env` to deploy to a temporary `.dev` url for further testing.
Optionally, create a `staging` and a `release` tag/branch to keep track of releases and versions.



0 comments on commit c928743

Please sign in to comment.