Skip to content

Latest commit

 

History

History
68 lines (52 loc) · 3.49 KB

README.md

File metadata and controls

68 lines (52 loc) · 3.49 KB

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 (www.wwdcscholars.com).

This repository contains the Vue.js based website that lists current and previous scholarship winners from all around the world.

Getting Started

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

Create a .env file at the root of this project that looks like this:

DEV_CLOUDKIT_CONTAINER_IDENTIFIER="<CloudKit Container Identifier>"
DEV_CLOUDKIT_API_TOKEN="<CloudKit API Token>"
DEV_CLOUDKIT_ENVIRONMENT="<CloudKit Environment>"

DEV_MAPKIT_JWT="<MapKit JS JWT>"

SENTRY_DSN="<Sentry DSN>"
DEV_SENTRY_ENVIRONMENT="<Sentry Environment>"

DEV_PLAUSIBLE_DOMAIN="" # no analytics for dev environment

WWDC_YEAR="<The WWDCYear key to use>"

Install dependencies

$ yarn install

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 build
    

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 Website is available under the MIT license. See the LICENSE file for more information.