vthacks
VTHacks - hackathon
Build Setup
# install dependencies
npm install
# serve with hot reload at localhost:8080
npm run dev
# build for production with minification
npm run build
For detailed explanation on how things work, checkout the guide and docs for vue-loader.
Development Workflow
-
Please create a new branch to work on a task
git checkout -b <yourname-task-name>
-
When you are done, please create a clean pull-request.
-
It is up to you if you want to fork the repo and push to your own forked repo or just push to this repo.
-
Please use 4 spaces and if possible use ESLINTER.
Tools being used for development
-
We are using VueJS framework with Firebase if you are new to one of them please read documentation:
-
For the UI components, we are using a mix of Google Material and Bootstrap v4.
-
If any questions arises, please don't hesitate to create Github issue. Pinging one of us on the Vthacks-dev FB groupchat is a good way to let us know about the issue you created.
List of features for VTHacks app
=================================
Web App, iOS App and Android app
- Landing
- Registration
- Schedule + Map
- A view just for VTHacks team to update the schedule
- PUSH notifications to everyone (?)
- List of teams, their submissions + table number (Check if DevPost has an API)
- Once you register have a section to create a team or join a team.
- Help request system
- Resume database (only for sponsors to see) Only for the web app?
- Chat system (low priority)
Maybe we can have 4 and 5 as just one view.
API (no more API, but rather just Firebase)
- User
- Have ability to POST, GET, PATCH, DELETE its own content
-
Name
-
School
-
Age (?)
-
Gender
-
Social media
-
Resume
-
Create/join team (no more than 4 ppl per team)
-
Phone number (?)
-
Schedule
- Have ability to GET, PATCH, DELETE the schedule
- Flexibility to change times (?)
- Teams
- Ability to POST, GET, PATCH, DELETE a team
- Up to 4 ppl per team
- Generate a team number which will be their table number as well.
- Request help per team.
Contact: developers@vthacks.com