Skip to content

An event planner that suggests venues, catering, entertainment and other details you might need to plan for your event depending on your budget.

License

Notifications You must be signed in to change notification settings

Raimeeab/Planit

Repository files navigation

GitHub License GitHub Language Count GitHub Pull Requests GitHub Closed Issues Branch Check Main GitHub Commit Activity

PlanIT


Table of Content

📝 Description

Dear unorganised event planner, we've got you covered! This application will create and manage all of your upcoming events in the same place by helping you choose from your favourite vendors and venues.

Link to the site

app-demo

🕹 User-story

As a user,
WHEN I create an account,
THEN I am able to create a new event and view previous events made.
WHEN I click on add event,
THEN I am prompted with questions regarding my event.
WHEN I complete the prompts,
THEN I am presented with potential venues and vendors for my event.
WHEN I click on vendors or venues,
THEN I am able to see all the vendors and venues available for hire in the database.

🕹 Technologies used

  • Node.js
  • Express.js
  • Heroku
  • Sequelize
  • MySQL
  • Insomnia
  • Dotenv
  • Handlebars
  • Bootstrap CSS
  • Nodemailer
  • bycrypt
  • eslint
  • prettier
  • nodemon

⚙️ Installation

  1. Git clone this repository onto your local machine and navigate to the file on your terminal. This can also be done by opening the file on Visual Studios and running it through the intergated terminal.

git-clone

  1. In order for the app to function correctly, ensure you have the latest or most stable version of Node.js and that you've entered your MySQL details (user & password) into the .env.EXAMPLE and rename the file to .env.

env-example

  1. Create the schema from the MySQL shell by running:
    • mysql -u root -p (enter password if/when prompted)
    • source db/schema.sql

sql-example

  1. Run npm install to download all the required dependencies and seeds

install

  1. To start the application, run:

    • npm run start

start

  1. Using insomina, more venues and vendors can be added and/or updated:
  • POST/ PUT routes:
    http://localhost:3001/api/venues/:id
    http://localhost:3001/api/vendors/:id
    http://localhost:3001/api/events/:id/venue/:venue_id

insomina-demo

  • Query venue capacity by number of guests: http://localhost:3001/api/venues/capacity/:capacity

  • Query venue & vendor prices by user budget: http://localhost:3001/api/venues/budget/:budget
    http://localhost:3001/api/vendors/budget/:budget

insomina-queries

🖥 Usage

This application allows the user to create an account and input event details to get suitable venues and vendors. The user can then contact them directly to check availability. Once the desired vendors and venue are selected, the user an event card will be created with all their details.

👥 Contributors

Raimee Abbassi
Nick Smith
Adrian Szonyi
The Univserity of Sydney | Trilogy Education Services

🔖 License

MIT License Copyright (c) [2021] [PlanIT] Permission is herby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limiation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject following coditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MECHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OF OTHER DEALINGS IN THE SOFTWARE.


🤝 How to Contribute

For information on how to contribute, please follow the guidlelines listed in Contributor Covenant.

❓ Questions

If you have any questions, contact us via email. You can also find more of our work here:

Raimee Abbassi
Nick Smith
Adrian Szonyi

About

An event planner that suggests venues, catering, entertainment and other details you might need to plan for your event depending on your budget.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published