/bundle_frontend

A mobile-first, trip-readiness app

Primary LanguageJavaScript

Bundle The Trip Readiness

Bundle

A mobile-first, trip-readiness app

Bundle relieves packing worries by showing travel goers what to pack from one place. Given the destination and duration of a trip, Bundle will create a customizable packing list. Once items are confirmed for a trip, travel goers can start tracking their packing progress. Bundle also has handy features like creating last-minute todo lists and storing booking information so that travel goers never have to feel like they’ve forgotten something important.

Table of Contents 🗂
1 Getting Started
2 Prerequisites
3 Usage and Installation
4 Built With
5 Contributing
6 Authors
7 Acknowledgments

Getting Started 📄

Prerequisites

  1. This project was bootstrapped with Create React App.

  2. Bundle Back-End API

  • Minimum requirement:
    • git clone https://github.com/aionate0812/bundle_backend
    • MapQuest API Key: https://developer.mapquest.com/documentation/
    • DarkSky API Key: https://darksky.net/dev
    • Postgres Database: https://postgresapp.com/ we recommend Postgres.app
    • Firebase Authentication Config:
      • Docs: https://firebase.google.com/docs/auth?authuser=0
      • Console: https://console.firebase.google.com/project/_/authentication/users

Usage and Installation

  1. In /src rename * firebaseConfigExample to * firebaseConfig and replace the Firebase Configurations with your own.
export default {
    apiKey: "",
    authDomain: "",
    databaseURL: "",
    projectId: "",
    storageBucket: "",
    messagingSenderId: "",
    appId: ""
  };
  1. In /src rename * configExample.json to * config.json and replace the API configurations with your own.
// Map Quest API used to parse city name into longitude and latitude coordinates
// Dark Sky API to get the weather 
{
    "MQ_API_KEY":"",
    "DARKSKY_API_KEY":""
}

  1. npm install

  2. npm start

Deployment ⛓

  1. We recommend Firebase: Docs: https://firebase.google.com/docs/hosting?authuser=0

Built With 🛠

Libraries
axios GitHub npm
bootstrap GitHub npm Web
firebase GitHub npm Web
i18n-iso-countries Github npm
libphonenumber-js Github npm Web
moment GitHub npm Web
react Github npm Web
react-burger-menu Github npm Web
react-circular-progressbar Github npm Web
react-dates Github npm Web
react-router-dom Github npm Web
react-toastify Github npm Web
react-with-direction Github npm

Contributing 👁

  1. Clone or Fork repo
  2. Switch to developmentMaster branch
  3. Fork a branch for each new feature you'd like to add
  4. Before pushing changes, switch to developmentMaster then git pull for latest updates.
    • Switch to your branch
    • Merge developmentMaster into your branch
    • Resolve any conflicts
  5. Push your branch
  6. Create Pull Request against developmentMaster

Authors 📚
🧙Pam GitHub LinkedIn
👩‍🚀Rupa GitHub LinkedIn
👨‍🎤Alex GitHub LinkedIn
👨‍🚀Robert GitHub LinkedIn

Acknowledgments 🤜🤛

Special thanks to our tech mentor Josh & our instructors Mo & Taq.