Skip to content

Commit

Permalink
update most files to reflect 2018 fcc jamstack hackathon. still a wor…
Browse files Browse the repository at this point in the history
…k in progress. see pr comments
  • Loading branch information
dunphyben committed Oct 26, 2018
1 parent ea2f2c2 commit 8d3dd12
Show file tree
Hide file tree
Showing 10 changed files with 265 additions and 328 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Team name
### Less than 160 Characters describing what we're building. Include external links here if desired
* Teammates: csv with your Reactathon Slack username.
* Teammates: csv with your Reactathon Discord username.
* Seeking Teammates: Yes/No
* [Project URL](https://github.com/your-profile/your-project-name)
* Project Name (ok to say tbd and update later)
Expand Down
17 changes: 17 additions & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# FAQ
Frequently Asked Questions

## Where's my ticket to the hackathon?
We had an extensive *application* process that was detailed by Quincy on at https://hackathon.freecodecamp.org/ . If you *successfully* completed this process, and you were *one of the first 300 to do so* (for the in-person event), then you were sent a ticket to the email address provided in your application. If you do not have a ticket then I'm sorry, but you cannot participate.

## What is the JAMstack?
The JAMstack is a powerful new approach for deploying fast, highly scalable sites and applications that don't require backend infrastructure. Thanks to recent advancements in the web platform, developers can now run any web property, from simple sites to complex applications, on global CDNs and without a single web server. Learn more about how the JAMstack works [here](https://jamstackconf.com/what-is-jamstack).

## Can the online participants and in-person participants be on the same team?
Unfortunately no. This makes things needlessly complicated. Further, there are separate prizes and judging protocol for the online and in-person hackathon. If we discover that your in-person team has remote collaborators, you will be disqualified.

## Can the online/in-person hackers still chat?
Of course. We're all in the same Discord chat group. And since this hackathon is largely about education, the in-person/remote groups should both help each other out by answering questions.

## Where is the Discord Channel?
Check your email for the Hackathon Discord Group invite.
54 changes: 42 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,62 @@
# 2018 freeCodeCamp JAMstack Hackathon

## What is a hackathon?

A hackathon is an event where people join teams and code together, then show off the projects they built. They usually only last one or two days, and often involve judging and prizes.

## How is this hackathon different?

Most hackathons focus principally on the end-goal -- the product. While this hackathon places a significant amount of focus on the end-product as well, we are also placing a significant amount of focus in the *process* of how you approach building your project.

### The Process -- what it means

Building great software isn't just about the code you write. Your planned approach to building it that is equally if not more important. So here's what this means for you as a hacker at this hackathon:
* Judges will pose a number of questions for you, and share them with you in the Discord group
* Judges will visit teams and ask you these questions to see how you are handling your approach to building your app. Do you have a plan of action? Are you organized in your list of responsibilities and dividing tasks? Are the goals realistic given the limited time frame?
* This will take place shortly after lunch.



# Hackathon Rules & Guidelines
Please read this in its entirety, including the other files. It includes specific instructions to get set up.
Please read this repository in its entirety, including the other files. It includes specific instructions to get set up.

## Code of Conduct
By attending the hackathon, you affirm that you have read and agree to our Code of Conduct, and you will abide by its guidelines laid out here: http://jsconf.com/codeofconduct.html
By attending the hackathon, or participating remotely, you affirm that you have read and agree to our Code of Conduct, and you will abide by its guidelines laid out here: https://jamstackconf.com/code-of-conduct

Note: This code applies to both in-person and online interaction.

## Purpose
The Hackathon is designed to be a fun, casual, and educational environment. There will also be competition for prizes, but our main goal is education, building community, and learning to use some cool APIs and technologies.
Thanks to our generous sponsors, we will provide you with lunch on Saturday, and lunch + dinner on Sunday. We will have beer & wine on Sunday evening to unnwind.
The Hackathon is designed to be a fun and educational environment. Of course there will also be competition for prizes -- but our main goal is education, building community, and learning to use some cool APIs and technologies!

## Perks

Thanks exclusively to the generosity of GitHub, you will have coffee, breakfast, lunch, and light dinner on all three days! 👏*applause for GitHub*👏

Send them a thank you note for being the most amazing hosts on [Twitter](https://twitter.com/github)!

Once hacking ends on Sunday, we'll celebrate with some beer and wine, and watch the top 6 teams get interviewed, and the top 3 teams present on stage!

## Location
GitHub HQ
88 Colin P Kelly Jr St,
San Francisco, CA 94107

## Team Size
* Max team size: 7
* Recommended team size: 2-5
* Max team size: 6
* Recommended team size: 3-5

## Join the Hackathon Discord Group
See the link sent to your email

## Join the Reactathon Slack Group
Sign up [here](https://join.slack.com/t/hack-reactathon2018/shared_invite/enQtMzMyMTQyODIyODAzLTJkNzFkMjY5ZjJlMzgxNmUyM2U4YmU4NDVkZTU3MzVhYjFmZTVjMDgwY2Y1OTZiODk3YmVlNTllMTFjMGFiOTE)
##### More info:
* You can ask API sponsors questions directly in their respective channel, i.e. `#_api_eventbrite`
##### More info on Discord:
* You can ask API sponsors questions directly in their respective channel, i.e. `#api-netlify`
* Pay special attention to `announcements` channel. Do not post here.
* Ask and answer questions about certain technologies in the `q-and-a-<technology>` channel
* Have general communication in the `general` channel
* Find a teammate or a team in the `team-formation` team

## Review the APIs
Review the APIs in the slack group. Mingle with the API sponsors at their tables
Review the APIs in the [apis.md](./apis.md) file in this repository. Mingle with the API sponsors at their tables and in their Discord channels.

## Team Formation
#### If you have a team
Expand All @@ -37,4 +67,4 @@ Review the APIs in the slack group. Mingle with the API sponsors at their tables

#### If you don't have a team
1. Browse teams in the `teams.md` file of this repo
2. Contact team members via Slack or in-person on Saturday morning
2. Contact team members via Discord or in-person on Saturday morning
135 changes: 77 additions & 58 deletions apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,47 @@
Listed here are the APIs for your use.
* Browse the APIs here. Visit docs etc.
* Meet with the API sponsors at the hackathon, particularly on Saturday morning
* Communicate with the API sponsors via their [dedicated slack channel](https://join.slack.com/t/hack-reactathon2018/shared_invite/enQtMzMyMTQyODIyODAzLTJkNzFkMjY5ZjJlMzgxNmUyM2U4YmU4NDVkZTU3MzVhYjFmZTVjMDgwY2Y1OTZiODk3YmVlNTllMTFjMGFiOTE)
* Communicate with the API sponsors via their dedicated Discord channel.


# Eventbrite

# Netlify
Netlify automates deployment for your frontend, serving your apps and sites over our custom global Content Delivery Network. You won't need server-side rendering with our integrated [prerendering](https://www.netlify.com/docs/prerendering), [proxy redirects](https://www.netlify.com/docs/redirects), [form handling](https://www.netlify.com/docs/form-handling), [user authentication](https://www.netlify.com/docs/identity), [serverless Lambda functions](https://www.netlify.com/docs/functions), and more.

### Purpose
Developers everywhere are using the [JAMstack](https://jamstackconf.com/what-is-jamstack) approach to connect blazing fast frontends to a growing array of microservice APIs. There are lots of advantages to this, but sometimes you need to run a bit of server-side code. It's not worth running a whole server for, and that approach doesn't scale well, anyway. Serverless functions services like AWS Lambda are perfect for this, and Netlify's [new functions add-on](https://www.netlify.com/blog/2018/03/20/netlifys-aws-lambda-functions-bring-the-backend-to-your-frontend-workflow/) makes it easy to deploy, test, and access your Lambda functions right alongside the rest of your app.

### Challenges
<!-- We are looking for the most interesting app using Netlify's integrated Lambda [functions](https://www.netlify.com/docs/functions).
To be eligible for the prize, your app must be deployed to Netlify, and use at least one Lambda function. -->

### Docs
https://www.netlify.com/docs/


### Video tutorial


### Presentation slides
<!-- Find links to all the docs!
http://hack2018.netlify.com -->

### Prizes


***



# Fauna
#### Quick Description


### Purpose


##### REST API endpoint:
##### API endpoint:


### Challenges
Expand All @@ -24,142 +54,131 @@ Listed here are the APIs for your use.
### Video tutorial


### Presentation slides


### Prizes


***

## Netlify
Netlify automates deployment for your frontend, serving your apps and sites over our custom global Content Delivery Network. You won't need server-side rendering with our integrated [prerendering](https://www.netlify.com/docs/prerendering), [proxy redirects](https://www.netlify.com/docs/redirects), [form handling](https://www.netlify.com/docs/form-handling), [user authentication](https://www.netlify.com/docs/identity), [serverless Lambda functions](https://www.netlify.com/docs/functions), and more.
# Formspree
#### Quick Description


### Purpose
Developers everywhere are using the [JAMstack](https://www.quora.com/What-is-the-concept-behind-JAMstack) approach to connect blazing fast frontends to a growing array of microservice APIs. There are lots of advantages to this, but sometimes you need to run a bit of server-side code. It's not worth running a whole server for, and that approach doesn't scale well, anyway. Serverless functions services like AWS Lambda are perfect for this, and Netlify's [new functions add-on](https://www.netlify.com/blog/2018/03/20/netlifys-aws-lambda-functions-bring-the-backend-to-your-frontend-workflow/) makes it easy to deploy, test, and access your Lambda functions right alongside the rest of your app.

### Challenge
We are looking for the most interesting app using Netlify's integrated Lambda [functions](https://www.netlify.com/docs/functions).

To be eligible for the prize, your app must be deployed to Netlify, and use at least one Lambda function.
##### API endpoint:


### Challenges


### Docs


### Video tutorial


### Presentation slides
Find links to all the docs!
http://hack2018.netlify.com


### Prizes
$300 Amazon gift card split between team members

***

***

# Hasura
# Clarifai
#### Quick Description
Hasura provides instant backend APIs for your frontend, a simple `git push` to deploy your app and GraphQL APIs on PostgreSQL without any set up.


### Purpose
Almost every dynamic Web or Mobile App requires an API to talk to the Database, Authentication for User Identity, some form of File Management and an easy way to deploy.

Hasura makes your development fast with
* Instant Backend APIs for Database (GraphQL / HTTP JSON over PostgreSQL)
* Authentication APIs for multiple providers with a ready to use UI Kit.
* Filestore APIs to manage file uploads and retreival.

Imagine all of these APIs with permissions / access control defined by you for your application. And just doing a `git push hasura master` to deploy your app.

Hasura has quickstart projects so that you don't have to setup the initial project structure / boilerplate code. Head over to [Hasura Hub](https://hasura.io/hub) for cloning a boilerplate of your choice. For example - [hello-react](https://hasura.io/hub/projects/hasura/hello-react). This will be a ready to deploy project which will give you a hasura-app.io domain for your project, HTTPS enabled, HTTP/2 - gzip supported API Gateway so that its production ready.
##### API endpoint:


### Challenges


### Docs
- [Getting Started Hasura](https://docs.hasura.io/0.15/manual/getting-started/index.html)
- [Database](https://docs.hasura.io/0.15/manual/data/index.html)
- [Authentication](https://docs.hasura.io/0.15/manual/auth/index.html)


### Video tutorial
- [Introduction to Hasura Data APIs](https://vimeo.com/246571798)
- [GraphQL APIs over PostgreSQL](https://storage.googleapis.com/hasura-io-assets/website-graphQL-preview.mp4)


### Prizes
* Best React App on Hasura
* Best React Native App
* Best use of GraphQL APIs


***

# Nyentek

# Hasura
#### Quick Description
<!-- Hasura provides instant backend APIs for your frontend, a simple `git push` to deploy your app and GraphQL APIs on PostgreSQL without any set up. -->


### Purpose
<!-- Almost every dynamic Web or Mobile App requires an API to talk to the Database, Authentication for User Identity, some form of File Management and an easy way to deploy.
Hasura makes your development fast with
* Instant Backend APIs for Database (GraphQL / HTTP JSON over PostgreSQL)
* Authentication APIs for multiple providers with a ready to use UI Kit.
* Filestore APIs to manage file uploads and retreival.
Imagine all of these APIs with permissions / access control defined by you for your application. And just doing a `git push hasura master` to deploy your app.
##### REST API endpoint:
Hasura has quickstart projects so that you don't have to setup the initial project structure / boilerplate code. Head over to [Hasura Hub](https://hasura.io/hub) for cloning a boilerplate of your choice. For example - [hello-react](https://hasura.io/hub/projects/hasura/hello-react). This will be a ready to deploy project which will give you a hasura-app.io domain for your project, HTTPS enabled, HTTP/2 - gzip supported API Gateway so that its production ready. -->


#### API Endpoint:

### Challenges


### Docs
<!-- - [Getting Started Hasura](https://docs.hasura.io/0.15/manual/getting-started/index.html)
- [Database](https://docs.hasura.io/0.15/manual/data/index.html)
- [Authentication](https://docs.hasura.io/0.15/manual/auth/index.html) -->


### Video tutorial
<!-- - [Introduction to Hasura Data APIs](https://vimeo.com/246571798)
- [GraphQL APIs over PostgreSQL](https://storage.googleapis.com/hasura-io-assets/website-graphQL-preview.mp4) -->


### Prizes


***

# TokBox
# Pilon
#### Quick Description

Easy to use API for embedding WebRTC-based interactive live video into your web and mobile apps.

### Purpose

Allow your app users to communicate and be seen with Live Video.

The TokBox API builds on WebRTC and is available for JavaScript (browsers), iOS, Android and Windows. We have ReactJS and ReactNative sample code showing how to use the APIs within React. Modern browsers, including Chrome, Firefox and Safari, have WebRTC built-in and so JS apps can be easily run with no plugins. Mobile deploymemts simply include our SDKs.
##### API endpoint:

In addition to live video and voice, the API also provides screensharing, session recording, inter-client signaling, chat/messaging and other capabilities.

The TokBox cloud platform (PaaS) scales from one-to-one video interactions to large multi-party video chat sessions to interactive broadcasts to huge audiences, including concurrent streaming to Facebook, YouTube and Twitch. TokBox is trusted by thousands of global customers including leading social media apps and industry apps in Healthcare, eLearning, Financial Services and Entertainment.

### Challenges

Live Video augments the user experience of your app, so dev challenge is to think through your UX and when and how video communications enhances workflows and processes your users need to perform within your overall app design.

Social use-cases tend to emphasize users meeting ad-hoc and communicating between themselves while industry use-cases tend to emphasize well-defined moments such as doctor/patient consultations and eLearning classrooms with teachers and many students.

### Docs

Get started on our Hackathon page, which has all the links: https://tokbox.com/hackathon

Join the #tokbox channel on Slack and come talk to Manik and Aaron at the event!

### Video tutorial

### Prizes

$250 Prize for the team showing the best use of Live Video in a Web or Mobile App using our OpenTok APIs, including OpenTok ReactJS or OpenTok ReactNative. Prize provided in multiple Visa and Amazon gift cards that can be distributed between team members.
### Prizes

***

# Overall Winners
#### The top 6 teams will present to a panel of judges including representatives from Real World React, Eventbrite, and Netlify.
#### The top 6 teams will present to a panel of judges including representatives from freeCodeCamp, Netlify, Formspree, and Fauna.
Note: "Overall" winners are separate from the "API winners". Each API sponsor will have their own challenges and prizes.

### Prizes
* X Box One
* Playstation 4
* Smart TV
* Amazon Echo
* Google Home
* Roost Laptop Stands
* Tickets to Frontier Conf
* DJI Drone
* and more!
* TBA
6 changes: 3 additions & 3 deletions checklist.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Hackathon Checklist

- [ ] Make sure that you have a Universe ticket (from reactathon.com/hackathon)
- [ ] Sign up for the [Reactathon Slack Group](https://join.slack.com/t/hack-reactathon2018/shared_invite/enQtMzMyMTQyODIyODAzLTJkNzFkMjY5ZjJlMzgxNmUyM2U4YmU4NDVkZTU3MzVhYjFmZTVjMDgwY2Y1OTZiODk3YmVlNTllMTFjMGFiOTE)
- [ ] Make sure that you have a ticket from Tito. Check your email -- Quincy will have sent you an invite link.
- [ ] Join the freeCodeCamp JAMstack Hackathon Discord Group (invite link sent to your email for ticket holders)
- [ ] If applicable, add your team to the list at `teams.md` in this repo
- [ ] Review the `README.md` file for further instructions and guidelines
- [ ] Review the APIs on `apis.md` in this repo
- [ ] Ask questions to API sponsors directly on their slack channel (i.e. `_api_eventbrite`)
- [ ] Ask questions to API sponsors directly on their Discord channel (i.e. `api-netlify`)
- [ ] Bring a refillable water bottle
- [ ] **IMPORTANT: BRING A POWER STRIP** to use and share with others! We recommend putting tape on it to write your name
Loading

0 comments on commit 8d3dd12

Please sign in to comment.