Skip to content

README.md

Latest commit

 

History

History
29 lines (19 loc) · 1.69 KB

README.md

File metadata and controls

29 lines (19 loc) · 1.69 KB

landscape-data-template

Template for a local-first landscape technology data repo.

How to use this template

  1. Fork this repo and clone your forked repo.
  2. If there's already sample data for your technology, head over to the temporary-technology-info folder and copy the data.js file to your repo.
  3. If there's no sample data, just start filling things out in data.js.
  4. Run npm install to install the schema dependency. In your IDE, you should now get type safety for the data you're adding.
  5. Replace logo.dark.svg and logo.light.svg with a light mode and dark mode version of your logo.
  6. Update the details.md with a few details about your technology.

How to preview my data.js?

Go to the Local-first Landscape staging server. (ask Johannes or Jess for access) You can drag & drop it on this drop zone to preview it:

How to add my project to the hosted landscape page?

  1. Add your data repo to this repos.ts file by forking the local-first-landscape repo and creating a pull request.
  2. The landscape project maintainers will review your pull request and merge it if everything looks good.

Resources