Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create cumulative user-editable db #5

Closed
yochannah opened this issue Sep 25, 2017 · 14 comments
Closed

Create cumulative user-editable db #5

yochannah opened this issue Sep 25, 2017 · 14 comments
Labels
code-task This task will involve writing code of some sort - but it's okay to pick up and ask for help too! Hacktoberfest If it's October and you want to contribute to open source, this issue is for you! help wanted Input from others appreciated but not necessarily as easy at first-timers-only or good first issue mozsprint
Projects

Comments

@yochannah
Copy link
Collaborator

yochannah commented Sep 25, 2017

This will allow contributors to add / update reviews for the various journals

@yochannah yochannah created this issue from a note in Roadmap (Pre-Mozfest) Sep 25, 2017
@yochannah yochannah moved this from Pre-Mozfest to Post Mozfest in Roadmap Sep 25, 2017
@yochannah
Copy link
Collaborator Author

Loose specs:

@yochannah yochannah changed the title review items from #2 and create cumulative user-editable db Create cumulative user-editable db Oct 2, 2017
@yochannah yochannah added code-task This task will involve writing code of some sort - but it's okay to pick up and ask for help too! help wanted Input from others appreciated but not necessarily as easy at first-timers-only or good first issue Hacktoberfest If it's October and you want to contribute to open source, this issue is for you! and removed Hacktoberfest If it's October and you want to contribute to open source, this issue is for you! labels Oct 2, 2017
@stain88
Copy link

stain88 commented Oct 30, 2017

Hi 👋
Regarding free to host, you could potentially have a folder in this repository, and then use GitHub's API (https://developer.github.com/v3/repos/contents/) to get/post updates to the DB.
Otherwise, a self-contained DB could be hosted on e.g. https://www.heroku.com/

@JJ
Copy link
Collaborator

JJ commented May 9, 2018

Heroku can only use postgreSQL if you don't want to introduce your credit card. If it's a lightweight thing, and we want same people with access to the site to have access to the DB, we could just use a bunch of JSONs right here in the repository. Change each JSON with a commit, and you even have rollback capability. You can use that easily from static pages, and even add search capabilities in the frontend.

@yochannah
Copy link
Collaborator Author

@JJ I love the idea of PRs for json but I'm worries it wouldn't be accessible enough for not technical users - I think we'd need a proper db or at least a google form (but I think a db is probably easier to manage)

@ha0ye
Copy link
Collaborator

ha0ye commented May 10, 2018

So, regarding accessibility... what are the loose specs there? It seems like anything with formal DB would be difficult for non-technical folks to deal with (esp. if it requires specialized software).

I like Google Sheets as a general point of entry. Initial thoughts here if you need programmatic access is the R package for dealing with google sheets, then adding a few lines to Travis CI to run any necessary scripts?

@yochannah
Copy link
Collaborator Author

@ha0ye I'm open to any implementation so if R sounds doable then that's great! I agree it's important to not add technical barriers, as well. Do you need anything frmo me to start down the R route? I'l invite you as a contributor

@ha0ye
Copy link
Collaborator

ha0ye commented May 10, 2018

@yochannah Yeah, R is good for me, and I've been meaning to play around a bit with CI usage anyway. Would the basic goal be to render a page for the website with a table for the DB? It could be static or deploy something fancier, e.g. by using flexdashboards: https://rmarkdown.rstudio.com/flexdashboard/index.html

@yochannah
Copy link
Collaborator Author

@ha0ye yes! I also have a mock for the page look here: https://github.com/yochannah/code-is-science/blob/master/static/mocks/index.html

@JJ
Copy link
Collaborator

JJ commented May 10, 2018 via email

@yochannah
Copy link
Collaborator Author

I've met quite a few people who are intimidated by the github interface and how to write markdown. It's possible that academics who care about open source code do know markdown and github, but I don't want to exclude those who don't know github if at all possible. I think @ha0ye was going to use the R API to read from the spreadsheet, and we can use a google form to write to the spreadsheet so I don't think format is too big a problem

@JJ
Copy link
Collaborator

JJ commented May 10, 2018 via email

@ha0ye
Copy link
Collaborator

ha0ye commented May 10, 2018

My current thinking is that the CI can run the R scripts alongside anything else to generate the website. My lab currently uses a similar workflow for automated analyses on continually updating data (https://github.com/weecology/portalpredictions), so it's fairly straightforward for me to port some of the ideas over to here.

Would still need some sort of hook to auto-rerun CI upon updates to the google sheet, but that seems like not a huge technical hurdle, and could always be done manually if there's vetting of the form input anyway.

@JJ
Copy link
Collaborator

JJ commented May 10, 2018 via email

@yochannah yochannah moved this from Medium term to Soonest in Roadmap May 11, 2018
@yochannah
Copy link
Collaborator Author

This issue was closed by the above PR.

@yochannah yochannah moved this from Soonest to Done in Roadmap Jun 3, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code-task This task will involve writing code of some sort - but it's okay to pick up and ask for help too! Hacktoberfest If it's October and you want to contribute to open source, this issue is for you! help wanted Input from others appreciated but not necessarily as easy at first-timers-only or good first issue mozsprint
Projects
Development

No branches or pull requests

4 participants