Giter Club home page Giter Club logo

fritzing-parts-api-client-js's Introduction

This API is unmaintained and as far as we know, not used by anybody. See issue #19

fritzing-parts-api-client-js Build Status

This is a simple javascript/nodejs api client that connects to the fritzing parts data at https://fritzing.github.io/fritzing-parts. The api client support functions to fetch fzb, fzp and svg files.

File Structure

  • docs generated esdoc artifact
  • lib generated babel artifact
  • src the main sourcecode
  • test jest test code

Install

install with yarn

yarn add fritzing/fritzing-parts-api-client-js

or use npm

npm install fritzing/fritzing-parts-api-client-js --save

Usage

initialize an api client and fetch /fzps endpoint

const {FritzingPartsAPIClient} = require('fritzing-parts-api-client-js')
//import {FritzingPartsAPIClient} from 'fritzing-parts-api-client-js'

FritzingPartsAPIClient.getFzps()
.then((fzpz) => {
  console.log(fzps)
})
.catch((err) => {
  console.error(err)
})

Api Documentation

The complete Api Documentation can be found here: Api Docs

Development

clone the repository

git clone [email protected]:fritzing/fritzing-parts-api-client-js.git
make test
make lint

if you have lint errors you can try running make lint-fix to fix the errors

to build an es5 compatible version run

make build

to generate the docs, run

make docs

if you want to open the docs after generating in your browser, run

make docs-open

License

MIT License

fritzing-parts-api-client-js's People

Contributors

el-j avatar kjellmorgenstern avatar paulvollmer avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

fritzing-parts-api-client-js's Issues

Review README.md

Context:

Review the README.md before we make public the repository.

we need a good readme to have a good developer experience

Create fzp and svg obsolete GET request function

Context:

at the fritzing projects (fzz) we use obsolete parts and at the moment we cannot load

Solution or next step:

  • add the missing obsolete get request wrapper
    • for fzp
    • for svg
  • test the new code
    • for fzp
    • for svg

Archive

This repo is unmaintained for almost four years, and, as far as I know, unused. If nobody objects, I'll archive it.

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.