Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 3.41 KB

SUBMISSION_REQUIREMENTS.md

File metadata and controls

53 lines (35 loc) · 3.41 KB

📜Entry Submission Requirements

All teams are required to submit the following as part of their entry submission no later than the end of the Hackathon on Saturday March 5th 2022 at 8PM EST. The submitted entries shall be based on Sitecore 10.2 XM.

IMPORTANT 👀

You have to fill in the README.md file found in this repository. Copy in the content of ENTRYFORM.md as template.

🔧Sitecore Setup

You must use an elevated/Administrator PowerShell terminal to run the .\Start-Hackathon script.
Windows Terminal looks best but the built-in Windows Powershell 5.1 terminal works too.

The choice is yours as to how you install Sitecore locally for the Hackathon. There is no requirement on whether you setup with Docker, SIF/SIA, Sifon, SIFless, SIM, or [insert creative approach]. We do however require that the installation steps are simple, few, and require no magic to get your submission working. We encourage you to perform a fresh install and follow your own documentation to ensure that no steps are missed. It would be unwise to try any of these installation methods for the first time the day of the Hackathon because so much can go wrong; do what you know well and invest as much time as you can being creative working on your solution.

For those with prior experience working with Docker, we have provided a "starter kit" in this GitHub repository (thanks Anders) with a variety of options to speed things up. 🚀

Special setup for Idea #3

  1. Run the Start-Hackathon script from an elevated PowerShell terminal with the switch -IdeaThree

    .\Start-Hackathon -IdeaThree

This cannot be undone locally and can only be run once.

Run this on 1 machine, then commit and push to share the setup with the rest of your team.

To initiate the local docker development environment setup then follow the instructions found in the updated README.md file or simply run

```ps1
.\Start-Environment -LicensePath "C:\path\to\license.xml"
```

from an elevated PowerShell terminal and follow the on-screen instructions.

Note; the Hackathon README.md file is renamed to README-HACKATHON.md. Please use this for your ENTRYFORM.md.

📦Deliverables

Please read carefully — and thoroughly — to ensure you have not missed any of the requirements.

🍝Code

Notwithstanding the fact that value full creativity in your submission, we are going to be judgy here — we are judges, after all. Once your code is pushed to GitHub, we will look for the following with no exceptions:

  • Cleanliness of code
  • Clear documentation
  • Adherence to Sitecore best practices (Helix)

📼Documentation

The documentation requirements are extremely important. If the judges are unable to get your Hackathon project running then we can’t count it as complete. Here are items we expect to be included which must be pushed to the GitHub repo in the readme:

  • Short YouTube video (2-30 minutes) describing your project submission purpose, setup instructions, and how to use it.
  • One to two pages of documentation describing your project submission purpose with screenshots of the finished product and installation steps with screenshots where appropriate.

Read and follow the instructions in ENTRYFORM