Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 2.12 KB

index.md

File metadata and controls

48 lines (32 loc) · 2.12 KB
Raw
layout
default

Bienvenue!

This is a starter kit to help you start a project for the CFRP hackathon quickly. Feel free to use as much or as little of these resources and ideas as you find useful.

Please note, this website is itself a github repository, and we would welcome your input on it. If you have ideas or questions, or you find problems, please open a ticket, or better yet, fork it, fix it, and open a pull request!

Some suggested first steps.

1. Get familiar with the data

The project has generated a great deal of data. The first step to making use of it is to understand what it contains.

  1. Read the listing of data tables and definitions.
  2. Install an API browser and Explore.
  3. Ask questions about how data are structured if you have any.

We can of course create views and aggregations from the existing data, if there are different schemata that are preferable. Don't hesitate to make a recommendation.

2. Choose and define a project

On Friday afternoon, we'll have a chance to talk with researchers and other developers about possible project ideas. Choose one that interests you. Ask historians and developers any questions you have about how to proceed. In the meantime, have a look at some suggested project categories.

3. Hack!

Set up

  • Fork this site
  • Clone this repo locally; then:
  • git branch your-project
  • If there is a request in Postman that serves your purposes, you can click "Generate Code" to get a copy/pasteable API client in your language of choice.

Run this site locally

  • If you have ruby installed:
  • gem install bundler
  • bundle install
  • jekyll serve

Add your project to the site

  • Code!
  • git add .
  • git commit -m "Created hackathon project"
  • git push
  • Open a Pull request against the upstream repo.