Skip to content
This repository has been archived by the owner on Feb 16, 2023. It is now read-only.

Commit

Permalink
Add CSV review page (#1)
Browse files Browse the repository at this point in the history
* Configure dependencies

* Setup inital review page layout

* Remove unused packages

* Reset module to echo inputs

* Add update components to properly handle data

* Update types, build and bump version

* Add tests and remove dist

* Add tests and remove dist

* Add testing to CI script

* Remove redundant file view and update example.json

* Improve data type handling
  • Loading branch information
builditben authored Nov 24, 2022
1 parent 1d5e0cd commit 80b45b0
Show file tree
Hide file tree
Showing 22 changed files with 4,114 additions and 2,293 deletions.
19 changes: 0 additions & 19 deletions .eslintrc

This file was deleted.

28 changes: 28 additions & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
module.exports = {
root: true,
parser: "@typescript-eslint/parser",
parserOptions: {
project: "./tsconfig.json",
tsconfigRootDir: __dirname,
jsx: true,
},
plugins: ["@typescript-eslint"],
extends: [
"eslint:recommended",
"react-app",
"react-app/jest",
"plugin:@typescript-eslint/recommended",
"plugin:@typescript-eslint/recommended-requiring-type-checking",
"prettier",
],
rules: {
"@typescript-eslint/no-unused-vars": [
"warn",
{
varsIgnorePattern: "^_",
argsIgnorePattern: "^_",
},
],
},
ignorePatterns: ["dist/**", "types/**", "node_modules/**"],
};
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
node_modules/
dist/
3 changes: 0 additions & 3 deletions .pnpmrc
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
auto-install-peers=true

# PlanX Registry (AWS Staging)
@planx:registry=https://planx-781751952389.d.codeartifact.eu-west-2.amazonaws.com/npm/PlanX/
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,22 @@
# Document Review
# PlanX Document Review

This simple component is to provide a simple visual representation of data from a PlanX submission.

This module uses `vite` for development and exports a simple React component.

Scripts:
## Running locally

* `dev`: start a hot-reloading development server
* `build`: build output for importing
* `lint`: check and fix linting errors
- Install [pnpm](https://pnpm.io) globally if you don't have it already `npm i pnpm -g`
- Install dependencies `pnpm i`
- Start development server `pnpm dev`

NOTE: When updating this project, remember to run `pnpm build` to publish changes.
Other useful package scripts:

* `pnpm test`: run the test suite
* `pnpm lint`: check and fix linting errors
* `pnpm ci`: run continuous integration checks
* `pnpm build`: build the package

## License

This repository is licensed under the [Open Government License v3](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/).
Loading

0 comments on commit 80b45b0

Please sign in to comment.