https://github.com/solidlabresearch/solid-todo-app-vue

Solid ToDo application implemented using Vue
https://github.com/solidlabresearch/solid-todo-app-vue

linked-data prototype solid todo

Last synced: 26 days ago
JSON representation

Solid ToDo application implemented using Vue

• Host: GitHub
• URL: https://github.com/solidlabresearch/solid-todo-app-vue
• Owner: SolidLabResearch
• License: mit
• Created: 2022-08-02T05:55:05.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-24T08:46:20.000Z (over 1 year ago)
• Last Synced: 2025-01-13T08:44:00.402Z (29 days ago)
• Topics: linked-data, prototype, solid, todo
• Language: Vue
• Homepage: https://SolidlabResearch.github.io/solid-todo-app-vue/
• Size: 1.52 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    



Solid Tasks


This is an experimental tasklist application built on top of Solid, in an effort to identify challenges related to developing interoperable applications on top of Solid. This is **not intended for actual use** in any capacity whatsoever, and exists as a technical prototype.

There is a live version [available](https://solidlabresearch.github.io/solid-todo-app-vue/) published on GitHub Pages from the main branch.

## Dependencies

* [Vue](https://vuejs.org/) for the user interface

* [Vite](https://vitejs.dev/) for development server, building, bundling

* [Comunica with link traversal](https://github.com/comunica/comunica-feature-link-traversal) for reading and writing data

* [Small custom vocabulary](https://github.com/SolidLabResearch/solid-todo-app-react/tree/main/ontology) for describing the data

* [Community Solid Server](https://github.com/CommunitySolidServer/CommunitySolidServer) as local temporary data storage while developing, but other Solid pods should also work

## Compatibility

The latest known compatibility status with a number of servers implementing the Solid protocol is the following:

* Community Solid Server: compatible with version 6.0.0+ and probably 5.1.0+

* Node Solid Server: not tested

* Enterprise Solid Server: not tested

## Functionality

Thus far, the prototype offers the following functionality:

* Logging in and out with a WebID, where the OIDC issuer is discovered via `solid:oidcIssuer`, and displaying the user's name from `foaf:name` or `foaf:givenName` after logging in

* Creating, renaming and removing to-do lists and to-do entries within those lists, in a nested fashion

* Language selection between English and Finnish

## Storage strategies

The prototype also allows customising the storage paths for newly-created to-do lists and entries:

* Default without `pim:storage` present is `private/todos/todos` under the path that contains the WebID, and it is this way to match the React prototype

* Default with `pim:storage` present is `private/todos/todos` under the path pointed at by `pim:storage`

* The `http://example.org/todolist/pathTemplate` predicate can be used to define a custom path, for example `{storage}/tasks/{tasklist}`, with the following templates available to use in the string: `year`, `month`, `date`, `timenow`, `tasklist`, `task`, `storage`

Examples of different storage strategies that can be implemented with the template:

* All tasks in single file: `{storage}/tasks/singlefile`

* All lists in different files: `{storage}/tasks/{tasklist}`

* All individual tasks in different files: `{storage}/tasks/{tasklist}/{task}`

* All tasks for one year in their own file: `{storage}/tasks/{year}`

## Development setup

The project uses [Yarn](https://yarnpkg.com/) version 3 and up for package management, and offers the usual commands:

* `yarn dev` to start the Webpack development server to serve the application

* `yarn css` to start the Community Solid Server as a data storage for development, with users from [tests/users.json](tests/users.json)

* `yarn lint` for ESLint

* `yarn build` for bundling for production

For example, to start the application locally after cloning:

```

$ yarn install --immutable

$ yarn dev

```

For Visual Studio Code, a Vue extension such as [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) might be useful, potentially with [TypeScript takeover mode](https://vuejs.org/guide/typescript/overview.html#volar-takeover-mode).

## Issues

Any issues encountered can be reported via the GitHub issue tracker. However, before reporting issues, please note that this is not a production-ready application and is not intended for everyday use.