{"id":20631211,"url":"https://github.com/solidlabresearch/solid-web-app-template","last_synced_at":"2025-08-16T01:30:09.868Z","repository":{"id":180664746,"uuid":"664671507","full_name":"SolidLabResearch/solid-web-app-template","owner":"SolidLabResearch","description":"A template for a Solid Web app.","archived":false,"fork":false,"pushed_at":"2023-07-24T05:56:53.000Z","size":1904,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-15T18:50:33.313Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SolidLabResearch.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-10T13:45:34.000Z","updated_at":"2023-08-03T22:07:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"8c9a9499-5be0-4ba7-a423-9985df507f9f","html_url":"https://github.com/SolidLabResearch/solid-web-app-template","commit_stats":null,"previous_names":["solidlabresearch/solid-web-app-template"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/SolidLabResearch/solid-web-app-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidLabResearch%2Fsolid-web-app-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidLabResearch%2Fsolid-web-app-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidLabResearch%2Fsolid-web-app-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidLabResearch%2Fsolid-web-app-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SolidLabResearch","download_url":"https://codeload.github.com/SolidLabResearch/solid-web-app-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidLabResearch%2Fsolid-web-app-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270656052,"owners_count":24623308,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-15T02:00:12.559Z","response_time":110,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T14:11:34.026Z","updated_at":"2025-08-16T01:30:09.781Z","avatar_url":"https://github.com/SolidLabResearch.png","language":"JavaScript","readme":"# Solid Web app template\n\nThis template helps you to get started with creating a Solid Web app.\n\n## Features\n\n- [Community Solid Server](https://github.com/CommunitySolidServer/CommunitySolidServer) (CSS) to test with pods locally.\n- [Comunica](https://comunica.dev/) for querying pods and other data sources.\n- [Solid Authentication library](https://github.com/inrupt/solid-client-authn-js) \n  for authenticating with an identity provider.\n  You find the browser-specific documentation \n  [here](https://docs.inrupt.com/developer-tools/javascript/client-libraries/tutorial/authenticate-browser/).\n- [webpack](https://webpack.js.org/) to bundle the JavaScript.\n- [Cypress](https://www.cypress.io/) to test our app.\n\n## Usage\n\n1. Clone this repository via\n   ```shell\n   git clone https://github.com/SolidLabResearch/solid-web-app-template.git\n   ```\n2. Install the dependencies via \n   ```shell\n   npm i\n   ```\n3. Prepare the pods via\n   ```shell\n   npm run prepare:pods\n   ```\n4. Start Solid server with the pods via\n   ```shell\n   npm run start:pods\n   ```\n   The server is ready when the following message appears in the terminal\n   ```\n   Listening to server at http://localhost:3000/\n   ```\n   Keep this process running.\n5. In another terminal serve the app using webpack via\n   ```shell\n   npm start\n   ```\n   The app is ready when the following message appears in the terminal\n   ```\n   webpack 5.88.1 compiled successfully\n   ```\n6. Browse to \u003chttp://localhost:8080\u003e to use the app.\n7. Click the button \"Show book wish list (public)\" to view a public list of books on the pod\n   at \u003chttp://localhost:3000/example/wish-list\u003e.\n8. Log in with the WebID \u003chttp://localhost:3000/example/profile/card#me\u003e.\n   The email and password of the account are defined in `seeded-pod-config.json`.\n   This file is used also in step 3 to prepare the pods.\n9. Click the button \"Show book wish list (private)\" to view a private list of books on the pod\n   at \u003chttp://localhost:3000/example/favourite-books\u003e.\n\nIf at some point you want to reset the pod data,\nyou do \n```shell\nnpm run reset:pods\n```\n\n## Pod data\n\nYou find the initial pod data in the folder `initial-pod-data`.\nIt has two resources:\n- `favourite-books`: this list contains the favourite books of the user. \n   This list is private. only the user has read, write, and control access.\n   This is specified in `favourite-books.acl`.\n- `wish-list`: this list contains the wish list of book of the user.\n   This list is public: everybody can read the list, but only the user can write and control it.\n   This is specified in `wish-list.acl`.\n\nYou find the shape to which the above two resources adhere in `shapes/book-list.ttl`.\n\n## Pod accounts\n\nYou can add more accounts by updating the file `seeded-pod-config.json`.\nYou find more information about this file \n[here](https://communitysolidserver.github.io/CommunitySolidServer/6.x/usage/seeding-pods/)\n\n## Tests\n\nWe use [Cypress](https://www.cypress.io/) for our tests.\nExecute the following steps to run the tests.\n\n1. Start Solid server with the pods via\n   ```shell\n   npm run start:pods\n   ```\n   The server is ready when the following message appears in the terminal\n   ```\n   Listening to server at http://localhost:3000/\n   ```\n   Keep this process running.\n2. In another terminal serve the app using webpack via\n   ```shell\n   npm start\n   ```\n   The app is ready when the following message appears in the terminal\n   ```\n   webpack 5.88.1 compiled successfully\n   ```\n3. In yet another terminal start Cypress via\n   ```shell\n   npm test\n   ```\n4. A new window opens.\n5. Click on \"E2E Testing\".\n6. Select the browser you want to test with.\n7. Click on \"Start E2E Testing in [browser]\".\n8. The selected browser opens.\n9. Click on \"spec.cy.js\" to select the tests.\n10. The tests are automatically executed.\n\nYou find all details of the tests in `cypress/e2e/spec.cy.js`.\nYou find all documentation about Cypress [here](https://docs.cypress.io).\n\n## License\n\nThis code is copyrighted by [Ghent University – imec](http://idlab.ugent.be/) and\nreleased under the [MIT license](http://opensource.org/licenses/MIT).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolidlabresearch%2Fsolid-web-app-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsolidlabresearch%2Fsolid-web-app-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolidlabresearch%2Fsolid-web-app-template/lists"}