Skip to content

Commit 6cfac9c

Browse files
committed
Update README
[skip ci]
1 parent ad05a22 commit 6cfac9c

1 file changed

Lines changed: 14 additions & 2 deletions

File tree

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ We have evolved the app to now be centrally hosted so we can offer the product t
1515

1616
If you are interested in being part of this project, write us at [jointheteam@boxtribute.org](mailto:jointheteam@boxtribute.org)! You can also check out our [website](https://www.boxtribute.org/#join) for more details about the kind of help we need on this project.
1717

18+
## Developer instructions and info
19+
1820
### Preparation for Installation
1921

2022
- Install [Docker](https://www.docker.com/products/docker-desktop)
@@ -208,14 +210,24 @@ Therefore, a few additional guidelines when writing test:
208210
- When you want to execute a redirect, e.g. example by clicking a button or tab, please add an assertion after the click, e.g. of the url `cy.url().should('include', 'people_deactivated')`. Due to this assertion cypress will definitely wait until the redirect is executed.
209211
- Only if you use `cy.visit()` you can be sure that the cypress test wait until a page is fully loaded. Therefore, try to navigate as much as possible with `cy.visit()`.
210212

213+
## DevOps
214+
215+
### Release new version
216+
217+
1. `git checkout production`
218+
1. `git pull origin production`
219+
1. `git pull origin master --commit`
220+
1. For the deploy to the demo environment: `git push origin production`
221+
1. For the deploy to the production environment: `git tag -s v1.X.Y -m v1.X.Y` (bump X if DB migration involved) and `git push origin production --tags`
222+
211223
### Notes for setting up an Auth0 tenant
212224

213225
If you are setting up a new Auth0 tenant, we require access to the Auth0 Management API. In order to do this
214226

215227
- Under 'APIs' select Auth0 Management API, go to 'Machine to Machine Applications' and enable access
216228
- Grant scopes for read/update/delete/create users and users_app_metadata.
217229

218-
### Contribution guidelines
230+
## Contribution guidelines
219231

220232
You gotta be awesome and kind.
221233
For everything else, please see our [contribution guidelines](https://github.com/boxwise/dropapp/blob/master/CONTRIBUTING.md)
@@ -224,6 +236,6 @@ For everything else, please see our [contribution guidelines](https://github.com
224236

225237
Drop us an email to hello@boxtribute.org!
226238

227-
### License
239+
## License
228240

229241
See the [LICENSE](./LICENSE) file for license rights and limitations (Apache 2.0).

0 commit comments

Comments
 (0)