Skip to content

presentation-helper is a simple πŸ’‘ (but fast πŸš€ and scalable 🌍) productivity tool to help you and your attendees ace in presentations.

Notifications You must be signed in to change notification settings

jose-donato/presentation-helper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

28 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Logo

GitHub Sponsors Buy me a Coffee

presentation-helper - a small tool to help you and your attendees ace in presentations. Create a room and share it in seconds. Then you can share snippets and links that the attendees will see immediately.


Features

  • Simple πŸ’‘ - create room and share content in seconds
  • Fast πŸš€ - Static + realtime updates with Cloud Firestore
  • Scalable 🌍 - Next.js ISG combined with Cloud Firestore allows us to create new URL for the rooms on the fly
  • Modern πŸ›Έ - built using fresh frameworks
  • Installable πŸ“± - the web application is installable as a PWA offering a similar to native experience in all devices
  • Offline 😴 - with service workers, if the user is offline we display a static page offline page


Upcoming features

  • πŸ” master passwords to encrypt the room contents and limit its access
  • πŸŒ™ customizable themes (including dark mode)
  • πŸ™ ... tell me what do you want to see more by opening an issue!


Technologies used



App preview

The application is live, you can try it here

Homepage screen


Room screen


Offline screen



Scores

lighthouse - https://lighthouse-metrics.com/one-time-tests/5fad6c5a8ebad3000912d61e

Lighthouse results



carbon - https://www.websitecarbon.com/website/presentation-helper-vercel-app/

Carbon results



Funding

I'm starting my career and at the same time finishing my masters' in Cyber Security. If I helped you in any way please consider to support me in GitHub or by buying me a coffee.



Contributing

Contributions are welcomed. Feel free to PR or open an issue with ideas/bugs found. Check in the following section how to run the application locally.



Run in development mode

What you need:

  • backend: create a firebase account and project

    • create firebase project
    • create web application in firebase project
    • create cloud firestore in firebase project
    • grab apiKey, databaseURL and projectId from firebase configuration object - more info in firebase docs
  • frontend: this repository

git clone https://github.com/jose-donato/presentation-helper
cd presentation-helper
npm i
touch .env.local
npm run dev

.env.local file should look similar to this but with the credentials you grab from firebase:

NEXT_PUBLIC_FIREBASE_API_KEY="XXX"
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN="YYY.firebaseapp.com"
NEXT_PUBLIC_FIREBASE_PROJECT_ID="YYY"


License

This project is licensed under MIT. Feel free to use it where you need. However, consider to support me if my work has helped you.

About

presentation-helper is a simple πŸ’‘ (but fast πŸš€ and scalable 🌍) productivity tool to help you and your attendees ace in presentations.

Topics

Resources

Stars

Watchers

Forks