FlyBy Events

A mobile-first web app to create, track, and manage events.
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

I created FlyBy Events as a prototype for a mobile-first web app where users can register, create events, invite guests, and track each others' events.

FlyBy Events was created as my solo project at Prime Digital Academy.

This project has given me a great understanding of my own ability to learn and refine my skills, and push through challenges and app-breaking bugs with curiosity rather than anger or frustration. FlyBy is a very long way from being a viable consumer app, but is a functioning prototype that I am proud of.

A deployed version of this app can be accessed here.

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

This app was developed in node.js version 18.12.0. I can't guarantee functionality for any older versions of node.

Installation

1. Clone the repo

   git clone https://github.com/ozzythecoder/flyby-events-solo-project.git

2. Install NPM packages

   npm install

3. Create a .env file and enter a randomized session key

   SERVER_SESSION_SECRET = << RANDOM SESSION KEY HERE >>
   

4. Start your Postgres server and create a database under the name flyby-events-app
5. Build the database from the queries listed in database.sql
6. Spin up your backend server

   npm run server

7. Run your frontend client – this will navigate you to localhost:3000

   npm run client

(back to top)

Usage

⚠️ This app is only functional when viewed in a mobile-style browser under 600px in width. ⚠️

If this is your first time using the app, register with a username, password, email, and phone number.

Use the hamburger menu to navigate through the app.

Create an event by filling out the required fields and confirm the details.

You can edit and delete the event, and invite guests, from the event detail page. If your event is marked as public, the URL will be accessible to anyone, whether they have a FlyBy account or not. Visibility of private events is limited to the host and any invited guests.

Guests can add events, as well as subscribe to events. This is functionality for a future subscription feature, which will allow guests to receive text/email updates when event details change.

(back to top)

Roadmap

Potential future updates include:

• Archive events
• Server-side filtering
• Profiles
• Comments section for events
• Fully implemented text & email notifications

See the open issues for a full list of known issues, or to suggest a new feature.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated, with the understanding that I am a student and this was mainly created as a learning opportunity for myself.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

August McAllister - [email protected]

Project Link: https://github.com/ozzythecoder/flyby-events-solo-project

(back to top)

Acknowledgments

Thank you to:

• The Shawl cohort family at Prime Coding Academy
• My instructors Dane, Key, Liz, and Kris
• My family, friends, and partner

(back to top)