Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename the Web package.json to stop Snyk PRs #3374

Merged
merged 1 commit into from
Aug 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions examples/web/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
# Realm Web Test Repo

Tests and code examples for the [Realm Web SDK (realm-web)](https://www.npmjs.com/package/realm-web).
Tests and code examples for the [Atlas Device SDK for Web (realm-web)](https://www.npmjs.com/package/realm-web).

This repo is based on the [Create React App TypeScript template](https://create-react-app.dev/docs/adding-typescript/).

## Set up

Set up the project by installing the npm packages:
Currently, the team is evaluating the structure and maintenance of this test
project. It is not actively being maintained.

To avoid getting Snyk dependency update pull requests, we have renamed the
`package.json` file to `rename-me.json`. Before you can run the test suite,
rename this file back to `package.json` locally.

Then, set up the project by installing the npm packages:

```sh
yarn
Expand All @@ -25,3 +32,11 @@ Run tests with the command:
```sh
yarn test
```

## CI

While the test suite is under evaluation, we have temporarily removed the CI
that runs the tests in GitHub Actions. When/if we are ready to reinstate this
test suite, move the `web.yml` file in this directory to the `.github/workflows`
directory, and make any necessary updates, to reinstate the GitHub Action
that runs the tests on every PR that changes these files.
File renamed without changes.
File renamed without changes.
Loading
Loading