Skip to content

Commit fab29f3

Browse files
committed
Improve README
1 parent 076c499 commit fab29f3

File tree

4 files changed

+48
-4
lines changed

4 files changed

+48
-4
lines changed

README.md

+48-4
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,27 @@
99

1010
A next-gen hackathon registration system.
1111

12-
## Why
12+
## Features
13+
14+
15+
16+
- send emails via AWS SES
17+
- stores resumes in GCP
18+
- Google Calendar Integration for events
19+
20+
### User Roles
21+
- Organizer (Admin)
22+
- see hacker management view below
23+
- Volunteer
24+
- can scan people into events via NFC or manual search mode
25+
- Mentor
26+
- Hacker
27+
- can create and update application
28+
- see current application status
29+
- can RSVP after acceptance
30+
- Sponsor
31+
- supports permissions based on tier and company
1332

14-
We needed a way to manage attendees and we wanted to provide a great developer experience as well.
1533

1634
## Tooling
1735

@@ -24,14 +42,40 @@ We needed a way to manage attendees and we wanted to provide a great developer e
2442
- Passport
2543
- Express
2644

27-
## Screenshots
45+
# Screenshots
46+
47+
### Login Page
48+
![Login Page](./pics/vaken1.png)
2849

29-
:)
50+
- supports Github, Google, and Microsoft SSO logins
51+
52+
### Detailed Hacker Management for Organizers
53+
![Organizer Page](./pics/vaken-org.png)
54+
55+
- view individual hacker applications
56+
- fuzzy search + filter by various fields (first name, last name, email, school, grad year)
57+
- can have multiple search fields
58+
- filter by events attended
59+
- accept/reject hacker applications
60+
- export filtered hacker data to .csv
61+
62+
### Sponsors Management
63+
![Sponsor page](./pics/vaken-sponsor.png)
64+
65+
- create sponsorship tiers, and set permissions
66+
- create companies, associate with a tier
67+
- create sponsors, associate with a company
3068

3169
## Contributing
3270

3371
See [CONTRIBUTING.md](./CONTRIBUTING.md)
3472

73+
## Customizing for your event
74+
- constants: [./src/common/constants.json](./src/common/constants.json)
75+
- application questions: [./src/client/assets/application.js](./src/client/assets/application.js)
76+
- strings: [..src/client/assets/strings.json](.src/client/assets/strings.json)
77+
- email templates: [./src/server/mail/templates](./src/server/mail/templates)
78+
3579
## Thanks
3680

3781
- To [Netlify](https://netlify.com) for providing us with a free pro plan for this open source project.

pics/vaken-org.png

198 KB
Loading

pics/vaken-sponsor.png

102 KB
Loading

pics/vaken1.png

1.79 MB
Loading

0 commit comments

Comments
 (0)