Skip to content
/ lws-ucs Public

Use-cases for the Linked Web Storage Protocol

License

Notifications You must be signed in to change notification settings

w3c/lws-ucs

Repository files navigation

Specification 'lws-ucs'

This is the repository for lws-ucs. You're welcome to contribute! Let's make the Web rock our socks off!

Defining User Stories

LWS user stories are classified under the following categories:

  • Functional: specific features or capabilities (e.g., "As a user, I want to reset my password so that I can regain access to my account.").
  • Non-Functional: related to qualities of service, such as performance, security, or scalability (e.g., "As an administrator, I want the storage server to handle up to 10,000 concurrent connections at peak.").
  • Technical: related to infrastructure tasks (e.g., "As a Service Provider, I want the ability to archive LWS storages").
  • Spike: used to explore or research an unknown aspect of the project (e.g., "Research what Identity System supports delegation.").

How to build this spec

This repository uses the ReSpec toolchain. Please find below a quick getting started cheatsheet using the command line tools.

Setup respec for multiple use:

$ npm install --global respec

Update your environment with the following variables:

export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=1
export PUPPETEER_EXECUTABLE_PATH="/usr/bin/google-chrome"
# replace "/usr/bin/google-chrome" with path to Chrome executable on your system.
# On MacOS, it's generally:
# "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"

This spec uses the data-include attribute. For respec to work locally, the content MUST be served by a web server. One easy way to achive that is to run one from the project directory:

# Install a local HTTP server if not already installed (one time)
$ npm install -g http-server

# Start the server in your project directory
$ http-server
Starting up http-server, serving ./

http-server version: 14.1.1

Note that the server starts on port 8080. Now you can run respec to generate the spec index.html in the project root and test changes.

$ respec --src http://localhost:8080/spec/index.html --out index.html

About

Use-cases for the Linked Web Storage Protocol

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages