Code Monkey home page Code Monkey logo

covid-business-support's Introduction

coronavirus-business-support

Netlify status Production link

This is a (very) brief guide to the project and how to contribute new data to covidbusinesssupport.com. I'll hopefully flesh this out more but I'm trying to get the site up and running as quickly as possible. If you want to contribute a documentation / README PR, you're more than welcome!

Contributing new businesses

If you want to add a business to an existing location, these are the steps:

  1. Fork the project
  2. Add a new JSON file to src/json-data/businesses/the-location/
    • Choose a URL slug (eg stag-barber: lower case and numbers, with hyphens) and use it for the <filename>.json
    • Copy a nearby file or check out the template below for the actual content
    • The slug field must match the filename
    • Website and social fields can individually be null
  3. Raise a PR to this project (if you want a light demo, there's a pretend PR here)
  4. Netlify will deploy a preview build for you: watch the PR updates for a link when it's ready
    • The link is a little hard to find: expand Show all checks next to All checks have passed and you'll see a line with a green tick and the text netlify/covid-business-support/deploy-preview โ€” Deploy preview ready!, next to which is a Details link. Click that.
    • If there's a problem building the preview, you'll likely need to check the validity of your JSON and failing that run the build locally yourself
    • That's a bit to cover in itself, but if you're familiar with Gatsby, you need node v10.19, and to run npm run build after an npm install
  5. Once everything passes, ping unwitting and they'll help get it merged

Template JSON

{
  "name": "Company Name",
  "location": "Edinburgh",
  "slug": "same-as-filename-without-the-dot-json",
  "lastUpdated": "2020-03-18",
  "website": "https://the-website-or-null.com",
  "social": {
    "instagram": "IG handle or null",
    "twitter": "Twitter handle (no '@') or null",
    "facebook": "Facebook handle or null",
    "pinterest": "Pinterest username or null"
  },
  "measures": [
    "Information on changes to business",
    "Or special offers or products the business is offering",
    "You can use **Markdown**"
  ]
}

covid-business-support's People

Contributors

unwitting avatar tartanllama avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.