Prisjakt Feed Specification

This repository contains specifications and instructions of how to format feeds with price offerings for ingestion into Prisjakt. The documentation is published at https://schema.prisjakt.nu

Contribute

Feel free to contribute if you find anything that can be improved, open a pull request against this repository with you changes.

Auto Generated Content

The following content is auto generated from our internal systems in order to keep in sync with models and a fixed structure, hence it´s not advisable to make changes to these files. If you find something that needs to be corrected in these areas, please open an issue and describe the changes you would like to see.

• Field articles in docs/fields/*
• Example files in
  • docs/examples/_*.mdx
  • static/examples/*

Local Development

This documentation is based on Docusaurus head over to their documentation to see what features are supported.

First Time Setup

Here is a first time setup guide.

1. Install git

2. Install nodejs

   • Installation might require a restart of your terminal/apps to pick up the commands on path

3. Install yarn

   $ npm install --global yarn

4. Clone the repository to your computer

   git clone https://github.com/Prisjakt/feed-specification.git

5. In the folder you checked out, install the packages with yarn

   $ yarn

6. Pick a good text editor like (e.g. Visual Studio Code or Sublime Text) and open the folder you just cloned in it

Edit Workflow

1. Run Local Server

   $ yarn start

   • Please note that the search does not support local dev server. To test it, make a production build and then serve the page.

2. Open the page http://localhost:3000 in your web browser

3. Create a branch to hold your changes

   $ git checkout -b feature/fix-spelling-mistakes

4. Start editing the files in the /docs folder

5. Watch the content in the browser update automatically

6. Repeat until you are satisfied

7. Commit your changes with a good description

   $ git add . # add all files
   $ git commit -m "Descriptive message that follows conventional commits standard"

8. Push changes

   $ git push

9. Create a pull request