/web-form

This is the submission form for accepted WWDC Scholarship winners

Primary LanguageVueMIT LicenseMIT

WWDCScholars Form

WWDCScholars is a community of Apple WWDC Scholarship winners. Every year bright minds from all around the world compete against each other for a free ticket to Apple's yearly developers conference. The scholarship recipients share their winning projects in our iOS App and on our website (wwdcscholars.com).

This repository contains the Vue.js based sign-up form for scholarship winners.

Getting Started

WWDCScholars is based on Apple's BaaS, CloudKit. To use this project you need to obtain credentials for CloudKit, the Google Maps API and the Sentry Error Tracking Service.

The project uses the following environment variables which can be included using a .env file or just as standard environment variables

CLOUDKIT_CONTAINER_IDENTIFIER="<CloudKit Container Identifier>"
CLOUDKIT_API_TOKEN="<CloudKit API Token>"
CLOUDKIT_ENVIRONMENT="<CloudKit Environment>"

GOOGLE_MAPS_API_KEY="<Google Maps API Key>"

WWDC_YEAR="<The WWDCYear key to use>"

# Optional for issue reporting
SENTRY_DSN="<Sentry DSN>"
SENTRY_ENVIRONMENT="<Sentry Environment>"
SENTRY_AUTH_TOKEN="<Sentry API Auth Token>"

Install dependencies

$ yarn install // or npm

Build and run the app

  • In development mode using a local development server with hot-reload, etc.
    $ yarn dev
    
  • In production mode for static hosting
    $ yarn generate
    
  • In production mode with server-side rendering support
    $ yarn build
    $ yarn start // start the server
    

When building for production you can find the results in dist/.

A 404 page can be found at dist/404.html. You can use it in nginx like this:

server {
  ...
  root /path/to/build/output;
  error_page 404 /404.html;
}

Contributing

We are always on the lookout for new ideas and improvements to the current version of this project. Do you want to help us shape the future of WWDCScholars? Check out what we are currently working on in the issues.

In case you have a technical question or need some guidance, don't hesitate to open a new issue yourselves.

Author

I'm Moritz Sternemann, a computer-science student at Technical University of Munich.

Related Projects

License

The WWDCScholars From is available under the MIT license. See the LICENSE file for more information.