Giter VIP home page Giter VIP logo

website's Introduction

SpaceApi

Note: This repository is obsolete since the formal specification has been worked out in the OpenSpaceLint repository in March 2012.

Canonical repository for the SpaceState API.

Branches

There are two primary branches: master and devel

master is the "gold standard current API", the current stable API which spaces should implement.

devel is the experimental branch where features and fixes are accrued between releases.

Extending the API

API extensions are welcome and encouraged! If you would like to propose an API extension, please contact our mailing list on the hackerspaces.org mailman so that we can discuss your changes. When you are ready to integrate them, please open a pull request pointed towards the devel branch.

Please do not adjust the changelog or API version tag; we will change this when we tag put out a new release.

Adding your space to the directory

Use the OpenSpaceLint tool to add your space.

add-new-space.png

website's People

Contributors

bouni avatar crimier avatar cyroxx avatar dbrgn avatar dependabot[bot] avatar devtown avatar dns2utf8 avatar ekaansharora avatar folkertvanheusden avatar gidsi avatar jhaand avatar niccokunzmann avatar pravasmohanty avatar rnestler avatar s3lph avatar zeno4ever avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

website's Issues

Add repository for simple micropython + PHP endpoint

When I look at the possibilities to provide an endpoint, I see quite some exotic choices and it doesn't provide the sensor + edge component
I created the implementation for an endpoint using NodeMCU, microPython and PHP on any server you like. It's very simple to get started. We used it during the Hacker Hotel event. See this post.

I would like this repository to be added to the 'provide Endpoint' page. It allows people to get started quite easily and then apply to spaceapi.io to get their endpoint in the directory.

You can find it here:
https://gitlab.com/jhaand/hacker-hotel-space-state

Add note about old website

Hi.

when I have a look at spaceapi.net, I do not see that spaceapi.io does exist. I think, the redirect could be more prominent.

Werkzeug requirements

Hey,

it seems that lektor has requirement Werkzeug<1 while flask has requirement Werkzeug>=2.0, hence statisfying the requirements is not possible. Does anyone else is facing this problem?

Regards,
Max

Document API requirements

API endpoints should return a HTTP200 status code. Furthermore, they should set the Access-Control-Allow-Origin: * header.

Add SpaceAPI Logo to header

Currently we just have the text "SpaceAPI" on the top left.
no-logo
It would probably make sense to add the SpaceAPI logo there.

directory.spaceapi.io has wrong content type and missing CORS headers

directory.spaceapi.io serves the wrong content type:

% http -h https://directory.spaceapi.io 
HTTP/1.1 200 OK
Content-Type: text/plain; charset=utf-8
Date: Tue, 21 May 2019 19:14:51 GMT
Transfer-Encoding: chunked
Vary: Origin

Compare it with https://spaceapi.fixme.ch/directory.json

% http -h https://spaceapi.fixme.ch/directory.json
HTTP/1.1 200 OK
Accept-Ranges: bytes
Access-Control-Allow-Origin: *
Cache-Control: no-cache
Content-Length: 10383
Content-Type: application/json
Date: Tue, 21 May 2019 19:19:01 GMT
ETag: "453735789"
Last-Modified: Sun, 19 May 2019 21:30:07 GMT
Server: lighttpd/1.4.35
Strict-Transport-Security: max-age=31536000

Add getting started section

It would be nice for people new to the SpaceAPI to be able to have a getting started guide which explains how to get a minimal static only SpaceAPI implementation up and running.
A good way would be via static hosting on GitHub or GitLab. Something like:

  • Set up an account on gitlab.com for your hackerspace.
  • Create a repository (example content, TLS activation, ...)
  • Create a PR to the directory repository
  • ...

Content is missleading / outdated

This fork aims to revive the development activity around the Space API. But we're always ready to discuss joining our forces back with the original project!

Check local dev env

The local development environment could be easier / more including.

What can we do? What should we consider?

Warn when using HTTP link to schema with the validator (is HTTPS-only)?

After doing a PR to the schema repo recently, it turned out that the validator doesn't accept HTTP pages even if CORS is enabled. Would be helpful to let the user know somehow - either detect "http://" in the URL and show a debugging message, or at least add a "Are you using HTTP? It might not work due to mixed-content policy" note to the debug log entry that is shown when the fetch fails (one that tells you about CORS). I've seen the "use debug console" suggestion in other issue, but the validator itself doesn't tell you that you can use it as a debugging tool - at the very least, a note about that would be helpful.

Required values

Why is spacefed for example marked as required but api is not.
If I validate without api in it, the validator raises an error {"valid": false, "message": "Data does not contain an "api" field"}, but if I omit spacefed the validator gives me {"valid": true, "message": null}

Mobile layout is suboptimal

The website layout looks ugly on mobile browser. We should probably add some responsive design magic ๐Ÿ˜‰

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.