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

Deno & vite #155

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
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
2 changes: 1 addition & 1 deletion front/.gitignore → .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
/coverage

# production
/build
/dist

# misc
.DS_Store
Expand Down
11 changes: 3 additions & 8 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
{
"eslint.enable": true,
"atlascode.jira.workingSite": {
"baseUrlSuffix": "atlassian.net"
},
"eslint.workingDirectories": [
{ "directory": "front", "changeProcessCWD": true },
{ "directory": "server", "changeProcessCWD": true }
],
"typescript.validate.enable": false, // Let Deno handle TypeScript validation
"javascript.validate.enable": false,
"deno.enable": true
}
12 changes: 0 additions & 12 deletions CONTRIBUTE.md

This file was deleted.

37 changes: 24 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,54 @@
# OpenBesluitvorming Search

Search through meeting documents of 320+ Dutch local governments. Powered by [Open Raadsinformatie](https://github.com/openstate/open-raadsinformatie/).
Search through meeting documents of 320+ Dutch local governments. Powered by
[Open Raadsinformatie](https://github.com/openstate/open-raadsinformatie/).

Check it out at [OpenBesuitvorming.nl](http://openbesluitvorming.nl)!

## Using the ORI API

Check out the [API docs](https://github.com/openstate/open-raadsinformatie/blob/master/API-docs.md).
Check out the
[API docs](https://github.com/openstate/open-raadsinformatie/blob/master/API-docs.md).

## Run front-end

- `cd front`
- `pnpm`
- `pnpm dev`
- `deno install`
- `deno run dev`

## Contribution guidelines

Read [contribute.md](/CONTRIBUTE.md)

## Deployment

Netlify tracks the `master` branch and deploys succesful builds to the [OpenBesluitvorming.nl](https://openbesluitvorming.nl) site.
Netlify tracks the `master` branch and deploys succesful builds to the
[OpenBesluitvorming.nl](https://openbesluitvorming.nl) site.

## Architecture

The [front-end](/front) is a search and browse GUI.
It's a typescript react application that uses [reactiveserach](https://github.com/appbaseio/reactivesearch) for search components and [react-pdf](https://github.com/wojtekmaj/react-pdf) to display PDF files.
The [front-end](/front) is a search and browse GUI. It's a typescript react
application that uses
[reactiveserach](https://github.com/appbaseio/reactivesearch) for search
components and [react-pdf](https://github.com/wojtekmaj/react-pdf) to display
PDF files.

## Connecting with Elasticsearch

Make sure ES has the [correct proxy settings](https://opensource.appbase.io/reactive-manual/getting-started/reactivebase.html#connect-to-elasticsearch).
Make sure ES has the
[correct proxy settings](https://opensource.appbase.io/reactive-manual/getting-started/reactivebase.html#connect-to-elasticsearch).

## Credits

- [VNG Realisatie](https://vngrealisatie.nl) for funding.
- [Open State Foundation](https://openstate.eu/nl/) for providing useful feedback on this project and starting Open Raadsinformatie.
- Software developed by [Joep Meindertsma](http://github.com/joepio) from [Argu](https://argu.co) / [Ontola](https://ontola.io).
- [Open State Foundation](https://openstate.eu/nl/) for providing useful
feedback on this project and starting Open Raadsinformatie.
- Software developed by [Joep Meindertsma](http://github.com/joepio) from
[Argu](https://argu.co) / [Ontola](https://ontola.io).
- Feedback from @breyten, @aolieman, @fletcher91, @jurrian
- Various open source projects that we're using, most notably ReactiveSearch and Link-Lib. Check out the `package.json` files to see which projects were used.
- [@aolieman](http://github.com/aolieman) and [Hendrik](http://github.com/henkieeeee) fpr implementing the Glossary feature (select text in PDF to view definition).
- Various open source projects that we're using, most notably ReactiveSearch and
Link-Lib. Check out the `package.json` files to see which projects were used.
- [@aolieman](http://github.com/aolieman) and
[Hendrik](http://github.com/henkieeeee) fpr implementing the Glossary feature
(select text in PDF to view definition).

<video src="https://user-images.githubusercontent.com/2183313/208661302-385fb00d-5be2-4c50-8159-591c7805e51c.mov"></video>
29 changes: 29 additions & 0 deletions deno.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"lint": {
"include": [
"src/"
],
"rules": {
"tags": [
"recommended"
],
"exclude": [
"no-explicit-any"
]
}
},
"compilerOptions": {
"lib": [
"dom",
"dom.iterable",
"esnext"
],
"strict": true,
"noFallthroughCasesInSwitch": true,
"jsx": "react-jsx",
"types": [
"vite/client",
"vite-plugin-svgr/client"
]
}
}
Loading