This is an example template for documenting a Pearson Student Coding Contest submission. The idea, app, and technologies are just for demonstration purposes. Substitute the details of your app below. This format is just a guideline. Make improvements as you see fit. This file uses Markdown formatting. There also comments in the raw file that describe the purpose of each section.
"My Contest App" enables students to control notifications related to their classes from their cell phone. This improves their awareness of assignments and due dates through customizable alerts. It is proven that today's students are more tech savvy than ever. They expect to interact with classes in the same way as their social networks. "My Contest App" makes courses more mobile and social by doing something remarkable...
See this project's hackathon entry page!
Watch a video of the application in action!
"My Contest App" utilizes a 3rd party messaging system to keep classmates alerted of assignments. This was chosen over text messages and push notifications because of the great selection of emoji and meme support.
- 3rd Party Messaging API - provides communication services
- LearningStudio API - provides class schedules and rosters
- LearningStudio Eventing - provides realtime notifications of class happenings
This application is mostly functional. The number of users able to use this application is limited by shortcuts taken for data storage. These were necessary to finish by the deadline, but replacing the temporary data store with a more scaleble solution would make this application ready for prime time!
- XCode 6.3.1 is required.
- Swift 1.2 is required
- Java 7 or greater is required
- Maven 2 is required
- Any app server supporting the Java 2.5 Servlet Specification
JavaServer/MyContestApp/src/main/resources/LearningStudio.properties
application_id={Application Id}
client_string={Client String}
iOS/MyContestApp/LearningStudio.plist
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>app_id</key>
<string>{Application Id}</string>
<key>client_string</key>
<string>{Client/Environment Identifier}</string>
</dict>
</plist>
Java Server
cd server
mvn clean package
iOS App - build with xCode
Java Server - copy target/my-contest-app.war to the server
iOS App - run in emulator
This project was a collaborative effort. We are all classmates in CS101 at Cool University.
- Jill Doe - marketing and presentation
- Joe Doe - graphics and videos
- Jane Doe - iOS application
- John Doe - java server application
This project would not have been possible without Professor Smith and Doctor Jones. They informed us of the coding contest and acted as mentored during the entire process.
My Chosen License
http://choosealicense.com/