Git Product home page Git Product logo

submit-data's Introduction

submit-data

This is a work-in-progress demo: submitdata.surge.sh

Submit data to a JSON file via a form using the GitHub API

It's useful to keep small datasets in GitHub repositories, particularly for projects that are more content-focused like maps and data visualizations that are hosted on gh-pages.

It would be very useful to provide a page where users can log in with the GitHub API, fill out a form, and have the fields appended to a JSON file that is an array of objects.

That's what this project will provide.

What does it do?

  • A user logs in via GitHub on the site.
  • They fill out the form with the fields you have specified.
  • This project does the following actions:
    • creates a fork on the user's account if it doesn't exist already
    • creates a branch for their changes
    • creates a commit adding an object to the JSON file you specified
    • creates a pull request back to the source repository

Todo

The next stage for this project is to make it reusable, so that you can provide a similar form in your gh-pages hosted repositories.

Similar functionality will also be added to the editdata.org project.

License

MIT

submit-data's People

Contributors

sethvincent avatar

Stargazers

Saiful Azfar Ramlee avatar Luke Swart avatar Chris Metcalf avatar Emanuel Feld avatar Shawn Allen avatar Lauren Ancona avatar Derek Reynolds avatar  avatar Athan avatar Yosh avatar Fraser Xu avatar Nate Goldman avatar Andrea Parodi avatar  avatar Kyle Robinson Young avatar Kevin Neff avatar

Watchers

James Cloos avatar Kevin Neff avatar Luke Swart avatar

submit-data's Issues

Use cases

How might this be used?

As it is currently written, it requires that a user have a GitHub account. That's not a bad requirement for tech-related projects, but anything where we're expecting contributions from the general public we'll need a slightly different approach. Assume, though, that general public contributions are possible after implementing something like a bot that makes pull requests on people's behalf: #12

Modularize

The next big priority for this project is to turn it into a module (or multiple modules) so that projects can easily add submission forms that will create pull requests as implemented in this demo.

Along with this will be adding the same functionality to the editdata/editdata.org project.

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.