Project Submission Guide

Follow these guidelines to properly submit your project for judging at Red Devil Hacks 2025.

Submission Deadline

All submissions must be completed by 8:00 PM on Saturday, April 5th, 2025.

Submission Requirements

Every submission must include:

  1. GitHub Repository - Your code must be in the Red Devil Hacks 2025 organization
  2. Demo Video - A 2-3 minute demonstration of your project
  3. README File - Comprehensive documentation with specific sections
  4. Presentation Slides (Optional) - For your final presentation

Step 1: Prepare Your Repository

Ensure your GitHub repository contains:

Required Files

  • Complete Source Code - All code needed to run your project
  • README.md - See detailed requirements below
  • LICENSE - Choose an appropriate open source license
  • .gitignore - Properly configured for your project type

README.md Requirements

Your README.md must include these sections:

# Project Name
 
## Team Members
- Full Name (GitHub Username)
- Full Name (GitHub Username)
- ...
 
## Project Description
A clear, concise description of what your project does and the problem it solves.
 
## Inspiration
What inspired you to create this project?
 
## What it does
Detailed explanation of functionality and features.
 
## How we built it
Technologies, frameworks, and tools used.
 
## Challenges we faced
Problems encountered and how you solved them.
 
## Accomplishments we're proud of
Highlight your achievements and learning experiences.
 
## What we learned
New skills or insights gained during the hackathon.
 
## What's next
Future improvements or features planned.
 
## Installation Instructions
Step-by-step guide to set up and run your project locally.
 
## Usage Guide
Instructions on how to use your application.
 
## Screenshots/Demo
Include screenshots or GIFs of your project in action.

Step 2: Create and Upload Your Demo Video

  1. Record a 2-3 minute video demonstrating your project

    • Show the main features and functionality
    • Explain technical aspects briefly
    • Highlight what makes your project unique
  2. Upload your video to one of these platforms:

    • YouTube (unlisted)
    • Vimeo
    • Google Drive (with sharing enabled)
  3. Add the video link to your README.md

Step 3: Final Project Preparation

  1. Clean up your code

    • Remove unused code and debug statements
    • Add comments where necessary
    • Format code consistently
  2. Check for sensitive information

    • Remove API keys, passwords, etc.
    • Use environment variables or config files (not included in repo)
  3. Verify everything works

    • Test on a fresh environment if possible
    • Make sure installation instructions work

Step 4: Submit Your Project

  1. **Provide the following information in the README (check out the template here: https://github.com/RedDevilHacks/Templates) and submit your project here: https://github.com/RedDevilHacks/Submissions **:
    • Team name
    • Project name
    • GitHub repository URL
    • Demo video URL
    • Brief project description (50-100 words)
    • Track category (Web, Mobile, Desktop, Data Viz)
    • Team member information

If selected as a finalist, you’ll have the opportunity to present your project to all attendees:

  • 3 minutes to present
  • 2 minutes for Q&A
  • Prepare 3-5 slides covering:
    • Problem statement
    • Your solution
    • Technical implementation
    • Demo or screenshots
    • Future directions

For questions about submission, contact us at chermsit@dickinson.edu or goblew@dickinson.edu