Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
GCHQDeveloper81 authored Jul 18, 2024
1 parent dea7f27 commit aeb1d48
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Copyright 2024 [Crown Copyright](https://www.nationalarchives.gov.uk/information

LD-Explorer is a prototype user interface built upon the [Comunica graph querying framework](https://comunica.dev/) that can be used for exploring linked data resources directly in the browser. We have found that this tool helps to better demonstrate the value and purpose of linked data to newcomers, and increases the speed at which experiments/ideas can be created and tested. We are open sourcing this software to fill what we believe is a software gap in the linked data linked data space and to hopefully encourage its growth into a valuable community tool.

LD Explorer is hosted at https://gchq.github.io/LD-Explorer/
LD Explorer runs entirely in the browser and is hosted at https://gchq.github.io/LD-Explorer/

## Documentation

Expand All @@ -21,26 +21,31 @@ LD Explorer is a UI that allows users to explore and experiment with linked data
- Run federated SPARQL queries across all active data sources.
- Persist SPARQL `CONTRUCT` queries back into local data sources.

## Development
## Local Development

To run this project you will need a development environment which includes _NPM/NodeJS_ - at least version 18.15 but ideally the [latest Node LTS](https://nodejs.org/en).
If you want to run this project locally on your own machine, you will need a development environment which includes _NPM/NodeJS_ - at least version 18.15 but ideally the [latest Node LTS](https://nodejs.org/en).

```
# Start the dev server
npm i
npm run dev
# Run the tests
npm test
# Run the component tests (via Vitest)
npm run test:unit+component
# Run the end to end tests (via Playwright)
npm run test:e2e
# Build for production (and test it locally)
npm run build
npm run preview
```

See `package.json` for more information.

## Contributing

This software is inner-source and contributions are welcome. See [Contributing.md](./CONTRIBUTING.md) for details. In terms of required experience/knowledge, the main technologies used within this project are as follows.
This software is open-source and contributions are welcome. See [Contributing.md](./CONTRIBUTING.md) for details. In terms of required experience/knowledge, the main technologies used within this project are as follows.

- [Typescript](https://www.typescriptlang.org/)
- [Svelte](https://svelte.dev/) / [SvelteKit](https://kit.svelte.dev/)
Expand Down

0 comments on commit aeb1d48

Please sign in to comment.