Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 23 additions & 20 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,24 @@

---
<h1 align="center">
<img src="assets/h2m-logo.png" alt="Logo" width="125" height="125">
<img src="assets/h2m_logo_alt.png" alt="Logo" width="175" height="175">
<br>
<img src="assets/company-logo.png" alt="CompanyLogo" width="200">
<br>
how2meet
<img src="assets/how2meet.png" alt="title" width="300">
</h1>

<p align="center">
Frictionless event manager
The frictionless event manager
<br/>
</p>

<details>
<summary>Table of Contents</summary>

- [About](#about)
- [Description](#description)
- [Motivation](#motivation)
- [Features](#features)
- [Roadmap](#roadmap)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Tutorial](#tutorial)
- [Screenshots](#screenshots)
- [Roadmap](#roadmap)
- [Maintainers](#maintainers)
- [License](#license)
Expand All @@ -38,36 +32,45 @@

**how2meet** is a *frictionless* event manager--meaning it is simple, free, easy to use, and does **NOT** require you or your guests to:
- Create an account
- Give out your personal information to a service you're not sure that you can trust
- Download an app

Just create your event and send a link with whatever service you choose!

## Motivation

### __Facebook is dead:__ _But Facebook Events was :fire:_
### __Facebook is dead :skull: :__ _But Facebook Events was :fire:_
- Facebook Events
- No one wants to download an app
- Planning a reunion with a big group of distributed, busy friends
- The hardest part of staying connected is someone taking charge and planning events. It takes time, effort, and often little thanks
-

## Features
- [ ] Host an event at a specific location, date, and time
- [ ] Send invites to guests via text, email, or web interface (link)
- [ ] Track RSVP responses, nudge those who haven't responded
- [ ] Admin access to limit attendees, kick out unknowns, change event details, and more!
- [x] Host an event at a specific location, date, and time
- [x] Send invites to guests via link
- [x] Track RSVP responses
- [x] Admin access to change event details

## Roadmap
- [ ] When2meet-style group scheduler
- [ ] GCal URL integration
- [ ] Polls
- [ ] Photos and comments
- [ ] AI-powered planning assistant
- [ ] Alternative communication paths (text, email, whatsapp, etc.)
- [ ] Nudge guests who haven't responded
- [ ] Geo-location search and presentation
- [ ] Admins to limit attendees, kick out unknowns

## Built With
| Library | Use | Source |
|-----------------------------------------|----------------|-------------------------------------------------|
| [nicegui](https://nicegui.io) | GUI | https://github.com/zauberzeug/nicegui/tree/main |
| [FastAPI](https://fastapi.tiangolo.com) | Backend | https://github.com/tiangolo/fastapi |
| [Render](https://render.com) | Infrastructure | https://github.com/renderinc |
| Library | Use | Source |
|------------------------------------------|----------------|-------------------------------------------------|
| [nicegui](https://nicegui.io) | GUI | https://github.com/zauberzeug/nicegui/tree/main |
| [FastAPI](https://fastapi.tiangolo.com) | Backend | https://github.com/tiangolo/fastapi |
| [Render](https://render.com) | Infrastructure | https://github.com/renderinc |
| [SQLAlchemy](https://www.sqlalchemy.org) | ORM | https://github.com/sqlalchemy/sqlalchemy |
| [Postgres](https://www.postgresql.org) | Database | https://github.com/postgres |

# Maintainers
| Name | Email |
Expand All @@ -79,6 +82,6 @@
# License
[GNU General Public License v3.0](https://choosealicense.com/licenses/gpl-3.0/)

# Acknowledgements / References
# Acknowledgements

[when2meet](https://www.when2meet.com)
Binary file added docs/assets/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/assets/company-logo.png
Binary file not shown.
Binary file added docs/assets/h.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/assets/h2m-logo.png
Binary file not shown.
Binary file added docs/assets/h2m_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/h2m_logo.pxd
Binary file not shown.
Binary file added docs/assets/h2m_logo_alt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/h2m_logo_alt.pxd
Binary file not shown.
Binary file added docs/assets/how2meet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.