Skip to content

Commit

Permalink
Merge branch 'master' into new-ui-updates
Browse files Browse the repository at this point in the history
  • Loading branch information
nellshamrell authored Feb 12, 2022
2 parents 86b60c7 + c4d812f commit 19a7b98
Show file tree
Hide file tree
Showing 16 changed files with 25 additions and 1,418 deletions.
16 changes: 1 addition & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ If you are interested in working on the code for the website, follow the steps b

## Fastest Set Up


The quickest way to get a fully functional local ClearlyDefined set up (including the website) is to use the [Dockerized ClearlyDefined environment setup](https://github.com/clearlydefined/docker_dev_env_experiment). This runs all services locally and does not require access to the ClearlyDefined Azure account.

## Alternative Set Up
Expand All @@ -30,21 +31,6 @@ This simple setup uses the _development_ instance of the service. That may be hi

Since you are not forced to consume only the local APIs, but you can even consume directly the remote development or production APIs, for the `website` repo only you are able to point out different APIs endpoints, depending on your needs, using different kinds of npm scripts: - `npm start` use the default environment, which is actually the DEV environment, and it refers to development APIs - `npm run start:dev-api` points out specifically to the development APIs - `npm run start:local-api` points out the local environment, which works only if the service repo is started - `npm run start:prod-api` points out specifically to the production APIs

### Running e2e Tests

If you want to test the development running e2e tests, just simply run:

- `npm run e2e:test` runs all the test that are saved into the folder `e2e/tests/`

You can write your own tests, just create a new file inside the `e2e/tests/` folder.
All e2e are written using `jest` and `puppeteer`.

Note that by default all the e2e tests runs checking the development website on https://dev.clearlydefined.io
If you want to run test on your local environment, you should run:

- `npm start` start the website as normal. Builds the application and starts it on localhost:3000
- `npm run e2e:test` run all the test checking on http://localhost:3000

# Contributing

This project welcomes contributions and suggestions, and we've documented the details in the [contribution policy](CONTRIBUTING.md).
Expand Down
5 changes: 1 addition & 4 deletions docs/rampup.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,10 @@ The website is a simple React app, see the [README](/README.md) for basic info.
* https://dev.azure.com/clearlydefined/ClearlyDefined/_build?definitionId=23&_a=summary
* https://dev.azure.com/clearlydefined/ClearlyDefined/_build?definitionId=28&_a=summary
0. First one uses azure-pipelines.yaml in repo, you can view that file to see what is running
0. Second one is e2e test, graphical setup of pipeline in AzDO
* Points to netlify preview.
* Uses ‘jest’ framework
0. Get your PR reviewed/merged
0. Once PR is merged:
* Pipelines runs to build and push container image to ACR, also artifact: drop
* Release: Deploys to Azure App Service (Linux/Docker), runs e2e test against dev.
* Release: Deploys to Azure App Service (Linux/Docker)
0. Can test change in dev environment now. (If it were more than a package version change)
0. Can push from master to prod, will start production build (requires write access)
* Builds and pushes image to ACR.
Expand Down
8 changes: 0 additions & 8 deletions e2e/jest.config.js

This file was deleted.

95 changes: 0 additions & 95 deletions e2e/maps/browse.js

This file was deleted.

117 changes: 0 additions & 117 deletions e2e/maps/definitions.js

This file was deleted.

75 changes: 0 additions & 75 deletions e2e/maps/fulldetailsview.js

This file was deleted.

33 changes: 0 additions & 33 deletions e2e/maps/harvest.js

This file was deleted.

Loading

0 comments on commit 19a7b98

Please sign in to comment.