From 8d3dd1294e6312b815cdc399878a14048d6ff852 Mon Sep 17 00:00:00 2001 From: Benjamin Dunphy Date: Fri, 26 Oct 2018 07:19:45 -0700 Subject: [PATCH] update most files to reflect 2018 fcc jamstack hackathon. still a work in progress. see pr comments --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- FAQ.md | 17 +++ README.md | 54 ++++++-- apis.md | 135 ++++++++++-------- checklist.md | 6 +- getting-started.md | 98 ++++++++++--- judging-protocol.md | 13 +- judging.md | 13 +- schedule.md | 24 ++-- teams.md | 231 +++---------------------------- 10 files changed, 265 insertions(+), 328 deletions(-) create mode 100644 FAQ.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d953111..acdfbeb 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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) diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 0000000..ea2345e --- /dev/null +++ b/FAQ.md @@ -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. diff --git a/README.md b/README.md index 6c948f4..5a6d5f8 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,40 @@ +# 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 @@ -13,20 +42,21 @@ GitHub HQ 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-` 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 @@ -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 diff --git a/apis.md b/apis.md index ca6dd00..ce09ba1 100644 --- a/apis.md +++ b/apis.md @@ -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 + + +### Docs +https://www.netlify.com/docs/ + + +### Video tutorial + + +### Presentation slides + + +### Prizes + + +*** + + + +# Fauna #### Quick Description ### Purpose -##### REST API endpoint: +##### API endpoint: ### Challenges @@ -24,89 +54,98 @@ 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 + ### Purpose + +#### API Endpoint: + ### Challenges ### Docs + ### Video tutorial + ### Prizes @@ -114,52 +153,32 @@ Hasura has quickstart projects so that you don't have to setup the initial proje *** -# 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 diff --git a/checklist.md b/checklist.md index e2c0a9d..0fc5c81 100644 --- a/checklist.md +++ b/checklist.md @@ -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 diff --git a/getting-started.md b/getting-started.md index ce718c5..6d6f660 100644 --- a/getting-started.md +++ b/getting-started.md @@ -1,31 +1,95 @@ # Getting Started -Here are some tools and resources to help you get started: -## Docs -1. Beginners: [Thinking in React](https://facebook.github.io/react/docs/thinking-in-react.html) + +### Contents +[The JAMstack](#the-jamstack) +[Front-end](#front-end) +[Cloud Functions aka Serverless](#cloud-functions) +[Deployment & Continuous Integration](#deployment) + + +# 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). + +# Front-end +The JAMstack really shines when you leverage a modern front-end library or framework such as React, Angular, or Vue. What's more, you can get set up almost instantaneously with the incredible static site generators (SSGs) that are available today. + +You can use whatever framework and SSG you please (or even Vanilla JS if you fancy), but here are a few that we like and recommend: + +## React + +### Education +1. Beginners: [Thinking in React](https://reactjs.org/docs/thinking-in-react.html) 2. Beginners: [ES6 Guide](https://mrzepinski.gitbooks.io/es6-guide/content/) -3. Beginner - Advanced: [Official React Docs](https://facebook.github.io/react/docs/hello-world.html) +3. Beginner - Advanced: [Official React Docs](https://reactjs.org/docs/hello-world.html) 4. Intermediate: [Official Redux Docs](http://redux.js.org/) -5. Advanced: [Intro to Reactive Programming](https://gist.github.com/staltz/868e7e9bc2a7b8c1f754) -6. Advanced: [RxJS Exercises](http://reactivex.io/learnrx/) -## Boilerplates -Boilerplates are great to get started, and to learn how someone uses certain tech and architects in a specific way. However, since you didn't make these choices on your own, you lose the education of _why_ someone chose to build their app in this manner, and it may actually slow you down or frustrate you in the long run. -**TLDR:** Boilerplates are great for hackathons, not so much for production. Use with caution. +### Static Site Generators +Many of today's static site generators have gone above and beyond the humble "boilerplate" label to establish a platform that, paired with a JAMstack architecture, is taking on the monoliths and behemoths such as Wordpress, Drupal, Ruby on Rails, and more. + +Here are a few static site generators that we like and recommned: -### [Create-React-App](https://github.com/facebookincubator/create-react-app) -This is the official boilerplate created by members of the React Core Team at Facebook with the help of open-source contributors. It is the easiest of all boilerplates, as it hides most of the configuration files to narrow your focus. You can get started in the CLI with: +#### [Gatsby](https://gatsbyjs.org/docs) ``` -npm install -g create-react-app -create-react-app my-app -cd my-app/ -npm start +npm install --global gatsby-cli +gatsby new gatsby-site https://github.com/gatsbyjs/gatsby-starter-default +cd gatsby-site +gatsby develop ``` -Create-React-App helps you to create a React project without worrying too much about configuration. To customize your boilerplate, you can "eject". Learn more about this and other features of create-react-app here https://github.com/facebookincubator/create-react-app -### [Create-React-Native-App](https://github.com/react-community/create-react-native-app) +#### [Create-React-Native-App](https://github.com/react-community/create-react-native-app) ``` $ npm install -g create-react-native-app $ create-react-native-app my-app $ cd my-app/ $ npm start ``` + +#### What about create-react-app? + +For JAMstack sites, even the create-react-app maintainers recommend Gatsby: +> If your website is mostly static (for example, a portfolio or a blog), consider using Gatsby instead. Unlike Create React App, it pre-renders the website into HTML at the build time. + +Source: https://github.com/facebook/create-react-app + +## Vue +Resources for getting started with Vue coming soon. + +### Education + +### Static Site Generators + +#### Vuepress +A popular static-site generator for Vue. Get started [here](https://vuepress.vuejs.org/). + + +## Angular +Resources for getting started with Angular coming soon + +### Education + +### Static Site Generators + + +# Cloud Functions +Popularly known as "serverless", this is a clever method of integrating backend infrastructure without serving backend code. Your backend code lives on another service, such as AWS Lambda or Microsoft Azure, and links up with your front-end code via JavaScript functions. This architecture not only makes your websites faster, more secure, and really cool -- it also saves you a substantial amount of money. While traditional server-side code will run indefinitely, Lambda functions will only run when called, and charge you per hundred-millisecond. AWS Lambda is currently the most popular of these providers, and you can see their pricing guide [here](https://aws.amazon.com/lambda/pricing/). + +Despite its popularity, if you've ever interacted with AWS services, you'll probably agree that it's not the most user friendly or intuitive. Fortunately there are plenty of services out there that can help you get started with Lambda functions without ever seeing their GUI. + +## Netlify Functions +Netlify lets you deploy Lambda functions without an AWS account, and with function management handled directly within Netlify. Your functions are version-controlled, built, and deployed along with the rest of your Netlify site, and we will automatically handle service discovery through our built-in API gateway. This eliminates overhead and brings the power of Deploy Previews and rollbacks to your functions. + +Get set up [here](https://www.netlify.com/docs/functions/). + +## Serverless +With the Serverless Framework you can define your entire Serverless application, utilizing popular Serverless technologies like AWS Lambda, with a simple yaml configuration file. You can deploy from a simple CLI interface to popular cloud platforms including AWS, Microsoft Azure, Google Cloud Platform and more. + +Get started [here](https://serverless.com/framework/docs/) + + +# Deployment + +With the JAMstack, the promise of a truly modern web architecture is not just limited to development, performance, and security. It also extends to the often-frustrating user experience of deployment, hosting, and continuous integration. + +What if you could do all of that with a simple `git push`? What if you didn't have to worry about FTP, https, url configuration, SSL, or dealing with the AWS console for your Lambda functions? + +That is what Netlify does for you and more. You can learn more about how to work and deploy with Netlify here: https://www.netlify.com/docs/ diff --git a/judging-protocol.md b/judging-protocol.md index 2bb5c6f..7fb04bc 100644 --- a/judging-protocol.md +++ b/judging-protocol.md @@ -1,12 +1,14 @@ # Judging Protocol & Schedule ### API Sponsors -If you are using one of the sponsored API's/Services, please list your project [here](https://docs.google.com/spreadsheets/d/13Yq8WBdu4jcMhrYZwljeWYk90-TdFAi4QcFvNCr5R80/edit?usp=sharing) +If you are using one of the sponsored API's/Services, please list your project [here](https://docs.google.com/spreadsheets/d/1z18JrsiSe8HYIG731z2Z87QHC3L9u2ALEie6zGzxPKU/edit?usp=sharing) ## Qualifying Pitches -**3:00 - 5:00pm, Main Stage** +**3:00 - 5:00pm, Main Stage** +You should be present by the main stage at least 5 minutes before your presentation is schedule to start. +This time may be adjusted depending on the number of hackers and teams present. -* 2 minutes, **hard stop** +* 1 minute, **hard stop** * 1 minute Q + A * Bring your laptop or phone to demo * We recommend practicing your pitch. Cut out any fluff. @@ -14,8 +16,7 @@ If you are using one of the sponsored API's/Services, please list your project [ * Ensure that your demo is ready & working; you will not get another chance. * Got slides? Sure, that's ok. But likely only working prototypes will advance you to the next round - -Review where you are on the schedule here: **Posted at 2:00pm** +Review your team's place in the queue for presentations here: **Posted at 2:00pm Sunday** We are using the US Navy Observatory Master Clock for time. If you're on a Mac, you should be synced to this, but it's worth verifying to make sure: http://www.usno.navy.mil/USNO/time/display-clocks/simpletime @@ -31,7 +32,7 @@ Note that the top 6 teams are contending for the *overall* hackathon winers. API ## Top 6 Teams Panel **5:30 - 6:30** -Winners will be announced in the Slack channel #announcements around 5:00pm. +Winners will be announced in the Discord channel #announcements around 5:00pm. ## Any commits after 6:00pm will disqualify you from overall prizes and presentations diff --git a/judging.md b/judging.md index 6df57dd..ea52144 100644 --- a/judging.md +++ b/judging.md @@ -1,16 +1,19 @@ +*Note: This document is under revision.* + # Rules If you are competing for prizes, you must: -1. Use React or React Native in a significant capacity -2. Max team size: 7 (Recommended team size: 2-5) +1. Use the JAMstack. You must not build a monolithic app or run a web server. +2. Max team size: 6 (Recommended team size: 3-5) 3. Abide by our code of conduct +4. To win API prizes, you must use their API. You can review them in [apis.md](./apismd) # Judging Criteria -Your project will be judged on: + diff --git a/schedule.md b/schedule.md index 351855d..5f8a604 100644 --- a/schedule.md +++ b/schedule.md @@ -1,27 +1,29 @@ # Schedule -Note: This schedule is a guideline. Actual times may vary. Watch for announcements in the slack channel `announcements`. +Note: This schedule is a guideline. Actual times may vary. Watch for announcements in the Discord channel `announcements`. ## Saturday, March 24 -8:30am - Doors open +9:00am - Doors open 9:00 - 10:00 - Check-in, coffee, mingle & form teams -10:00 - 11:00 - Welcome + Keynote (Main Stage) -11:00 - 12:30 - Hacking +10:00 - 11:20 - Welcome + Keynote (Main Stage) +11:20 - 12:30pm - Finalize teams, discuss projects and procedure 12:30 - 1:00 - Lunch -1:00 - 6:30 - Hacking -7:00pm - Doors close +1:00 - 6:00 - Hacking/Procedural Interviews +6:00 - 6:30 - Light dinner +6:30 - 8:45 - Hacking +9:00pm - Doors close ## Sunday, March 25 -8:30am - Doors open +9:00am - Doors open 9:00 - 10:00 - Check-in, coffee -10:00 - 10:45 - Welcome + Keynote (Main Stage) +10:00 - 11:00 - Welcome + Keynote (Main Stage) 10:45 - 12:30 - Hacking -12:30 - Lunch +12:30 - 1:00 - Lunch 1:00 - 6:30 - Hacking -3:00 - 4:30 - Teams present their projects to judges (actual time may change depending on number of hackers) +3:00 - 4:30 - Teams present their projects to judges (actual time may change depending on number of hackers and teams) 4:30 - 5:30 - Judges decide top 6 teams, no order 5:30 - 6:30 - Judges interview top 6 teams for video -6:30 - Dinner +6:30 - Pizza! 7:00 - 7:30 - Top 3 teams present (Main Stage) 7:30 - 8:00 - API Awards Announced 8:00 - 8:15 - Top 3 teams Awards Announced diff --git a/teams.md b/teams.md index a66e2a3..f0d0723 100644 --- a/teams.md +++ b/teams.md @@ -2,232 +2,33 @@ ### Create a PR and tag `@dunphyben` in the comments of that PR. -STYLE GUIDE: +### STYLE GUIDE: ``` -# Team name -### Less than 160 Characters describing what we're building. Include external links here if desired -* Teammates: csv with your Reactathon Slack username. +# Project Name +### Less than 240 Characters describing what we're building. Include external links here if desired +* Teammates: + - Teammate Name (@discordUserProfileName) + - Teammate Name (@discordUserProfileName) + - Teammate Name (@discordUserProfileName) * Seeking Teammates: Yes/No * [Project URL](https://github.com/your-profile/your-project-name) * Project Name (ok to say tbd and update later) -*** (be sure to include these three stars at the bottom for a horizontal rule) -``` - -*** - -# The Style Guide Exemplifiers -### We're a team that exists solely to show you how to edit this document. Fork this repo and make a PR to add your team at the bottom of the list! -* **Teammates**: Benjamin Dunphy (@ben), Tom Hanks (@tom) -* **Seeking Teammates**: No -* [GitHub URL](https://github.com/your-profile/your-project-name) - *** +``` -# Juiceathon -### Platform for coaching noobs videogamers to get one-on-one coaching from seasoned veterans -* **Teammates**: Albert Wong (@wongal5), Jackie Jou (@jackiejou), Derrick Cross (@decross1) -* **Seeking Teammates**: No -* [Project URL](https://github.com/Juiceathon/Noobvolution) -* Noobvolution - -*** - -# The Big Maacs -### Fan the flames of curiosity for yourself and for others on this online learning platform using with live and recorded video sessions -* Teammates: Amer Gheith (@agheith), Ghamoti Anye Angwafo (@grenti), Beth Stevic (@bethstevic), Gil Kwak (@gilkwak), Iris Yu (@iyyu), Muhammad Shoman (@Moe-Shoman) -* Seeking Teammates: No -* [Study Buddies](https://github.com/BigMaacs/studybuddies) -* Project Name: Study Buddies - -*** +Copy the above code snippet in its entirety and add it to the BOTTOM of this document. Then edit with your information. Don't forget the `***` three stars! -# Epic Tripz -### Find an eperienced travel guide to help plan your next vacation -* Teammates: James Kraus (@James Kraus), Geoff Wright (@Geoff Wright), Leland Barton, Jeff Mathis -* Seeking Teammates: Probably No -* [Live Site](http://epictripz.com) *** -# Team Assemble -### There are people all around the world who are eager to participate in the tech community but are geographically constrained. Assemble is an event platform that aims to solve that problem. -* Teammates: Roseanna McFarlane (@Roseanna), Stephen Bennett (@Stephen), Joshua Nelson,(@Joshua), Nicholas Higgins (@Higgs) -* Seeking Teammates: No -* [Github URL](https://github.com/RoseannaM/reactathon-2018) -* Assemble - -*** -# Team Nyentek -### An API-less sponsor, participating for the fun of it -* **Teammates**: Robbi Garza, Jason Hsu, Jamee Krzanich, Nate MacMillan, Randy Thompson +# Hackathon Style Guide Example Entry +### This project exists solely to show you how to edit this document. Fork this repo and make a PR to add your team at the BOTTOM of this list -- below the last 3 stars! Don't forget to include the 3 stars in your entry. +* **Teammates**: + - Benjamin Dunphy (@benghamine) + - Quincy Larson (@QuincyLarson) + - Matt Biilmann (@biilmann) * **Seeking Teammates**: No -* [GitHub URL](https://github.com/Nyentek) -* TBD - -*** - -# teamWillReceiveProps -### We're building an app for musicians and bands to share live music. -* Teammates: Isak Mladanoff (@isak), AJ Ansel (@ajansel), David Webster (@David Webster), Jesse Wong (@hesse), Andres Alfaro (@Andres Alfaro), Aaron Wayne (@niartenyaw). -* Seeking Teammates: No -* [Project URL](https://github.com/mladenoff/reactathon-2018) -* Project HearHere - -*** - -# Orange Box -### Livestream video platform for teaching -* Teammates: Andrew Kang (@Andrew Kang), Derrick Zhang (@Derrick_Zhang), Larry Chang (@lchang2190), Stephen Choe (@stphnchoe) -* Seeking Teammates: No -* https://github.com/andrewsjkang/Learn -* LearnLive - -*** - -# Whatever -### Match making for non-profits with volunteers -* Teammates: Ankit Agarwal (@Ankit), Jon Paul Santos (@John Santos), Thomas Machado (@Thomas Machado), Sashi Penta (@sahi), Anand Raman (@Anand) -* Seeking Teammates: No -* [TBD](https://github.com/your-profile/your-project-name) -* TBD - -*** - -# Hubtype -### Botonic is to messaging what React Native is to mobile, a framework that allows you to build chatbots for messaging apps with React. -* Teammates: Eric -* Seeking Teammates: No -* [Project URL](https://github.com/hubtype/botonic) -* Botonic - -*** - -# Snevil -### We're making an app for musicians to jam together. -* Teammates: Hayden Marx (@hayden marx), Jake Shasteen (@jake), Nuno Neves (@nuno), SJ Lee (@seungjulee), Will Putnam (@wsputnam) -* Seeking Teammates: No -* [Project URL](https://github.com/JamRoulette/JamRoulette) -* Project Name: JamRoulette - -*** - -# NoTow -### Don't tow me, bro. An app to read those ridiculous parking signs for you. -* Teammates: - - Chris McDermut (@chrismcdermut) - - Maria Nguyen (@mariawhen) - - Taylor Harwood (@taylorharwood) - - Gabe LeVasseur (@gabel0287) - - Mariia Rudenko (@RudenkoM) - - Nick Rebhun (@nrebhun) -* Seeking Teammates: No -* [Frontend](https://github.com/saf-scb/reactathon-client) -* [Backend](https://github.com/saf-scb/reactathon-api) -* Project Name: NoTow - -*** - -# btlgr (bootlegger) -### An app created to allow global discovery of local artists through multiple streams of an event. -* Teammates: - - Julie Lin (@julielin0812) - - Ryan Mapa (@ryan-mapa) - - Tyler Wood (@Woodentyler) - - Clay Shaw (@itsClay) - -* Seeking Teammates: No -* [Project URL](https://github.com/julielin0812/reactathon2018-btlgr/) -* Project Name: btlgr - -*** - -# Black Egret Studios -### Video AMA (TBD) creates an organized, collaborative lecture environment for conference calls by giving the presenter an intuitive interface to queue up speakers and participants. -* Teammates: Jack Wu, Vickie Chen, Mitch Yin, Tan Loc, Adeel Ahmad, Kangli Cheng, Alvin James Delos Santos -* Seeking Teammates: No -* [Video AMA](https://github.com/CelesteComet/besthack) -* Video AMA (TBD) - -*** - -# NotAlone -### You're not alone. A web enabled group therapy app to address mental health conditions -* Teammates: - - Chao Cao (@Chao) - - Wyatt Rudnicki (@Wyatt) - - Arpan NLN (@Arpan) - - Joey Feng (@Joey) - - Rose Lee (@roselee) - - Edward Cheng (@Edward Cheng) - - Dylan McCapes (@Dylan McCapes) - -* Seeking Teammates: No -* [Project Url](https://github.com/arpannln/ReactathonProject) -* Project Name: NotAlone - -*** - -# BlindArrow -### Finding love in all the right places. -* Teammates: - - Kai Hsia (@kaihsia) - - Nick Tang (@singsai) - - Wendy Cheung (@wendy-c) - - Joosang Lee (@armlessarcher) - - Clarabelle Cheung-Yue (@clarabellecheung-yue) - - James Tu (@jmsjtu) -* Seeking Teammates: No -* [Project URL](https://github.com/darkside-reactathon2018) -* Project Name: darkside - -*** - -# Solothon -### A way for API/service providers to give efficent remote video support to Hackathon teams -* Teammates: Huy Zing (@huy) -* Seeking Teammates: No -* [Project URL](https://github.com/huyz/hack-reactathon-2018) -* Project Name: Help A Hacker - -*** - -# Hackevents -### A way to easily see the number of available spots in local events so you can sign up before they fill up. -* Teammates: David (@David Adler), Michael (@Michael Campos), Neil (@neil), Vince (@Vincent Song), Tiffany (@tymeart) -* Seeking Teammates: No -* [Project URL](https://github.com/mfbx9da4/sf-hotevents) -* SF Hot Events - -*** - -# Game Face -### A short, competitive party game -* Teammates: - - Joey Doyle (@jdoyle5) - - Christine Song (@cdisong) - - Edan Lewis (@fishshiz) - - Truong Nguyen (@TmNguyen12) - - Anna Oh (@AnnaNOh) - * Seeking Teammates: No - * [Project URL](https://github.com/TmNguyen12/GameFace) - * Project Name: Game Face - -*** - -# Aztec Game Lab -### Do you enjoy sharing/making memes with your friends? Make memories in a "react" game, "mème brûlée"! -* **Teammates**: Brian Vo (@bryevo), Kevin Do (@Kevin-Do), AC De Leon (@acfromspace) -* **Seeking Teammates**: Negative! -* [Project URL](https://github.com/AztecGameLab/Reactathon-2018) -* **Project name**: mème brûlée +* [GitHub URL](https://github.com/your-profile/your-project-name) *** - -# typeof team === 'undefined' -### twitch style chat replay for video conference archives -* **Teammates**: Tim Gallant, Clinton Reece, Aram Danakian -* **Seeking Teammates**: No -* [Frontend](https://github.com/ardanak/tokbox-replay) -* [Backend](https://github.com/tgallant/chat_replay_api) -* **Project name**: TBD