Git Product home page Git Product logo

addressbook-lv's Introduction

Adddress Book Laravue README

This app is designed to showcase my abilities using php, laravel, and vuejs to create and store contacts and their related addresses to a database. Eventually, it will also include the ability for each user to have their own personalized address book.

Requirements

  • Must allow the user to create, edit and delete contacts
  • Must allow the user to create, edit and delete addressess related to the correct contact
  • Deleting a contact deletes all associated addressess
  • Deleting an address only affects that address
  • User friendly and intuitive userface
  • User friendly algolia instant-search

Installation

Installing the app:

  1. clone the Git repo
  2. run composer update
  3. Run npm install && npm run dev
  4. run php artisan migrate --seed
  5. run php artisan serve

Dependancies

  1. npm install vue
  2. npm install vue-router
  3. npm install carbon
  4. npm install view-design --save
  5. npm install --save vue-instantsearch

File Structure

All files are located in the resources/js/ folder

  1. Pages
    1. Contacts
      • index.vue => loads the contacts list with action buttons
        • data: contact.id, contact.firstName, contact.lastName, contact.email, contact.phone, contact. birthday
      • createContact.vue => loads a form for adding a new contact
      • editContact.vue => loads a form with current contact data and saves any changes
        • data: contact.id, contact.firstName, contact.lastName, contact.email, contact.phone, contact. birthday
      • deleteContact.vue => first ask for confirmation then deletes a contact and all of the associated addresses
        • data: contact.id, contact.firstName, contact.lastName, contact.email, contact.phone, contact. birthday
    2. Addresses
      • index.vue => loads the current contact data and addresses
        • data: contact.id, contact.firstName, contact.lastName, contact.email, contact.phone, contact. birthday, contact.address (all address data where the address contact.id foreign key is the same as the current contact id)
      • createAddress.vue => form for creating a new address under the current contact
      • editAddress.vue => form with current contact data and saves any changes
      • deleteAddress.vue => asks for confirmation and then deletes the address data
    3. Future Updates
      • Login with authentication
      • personal user dashboard and address book
  2. Routes
    1. vue routes are stored in router.js
    2. All AJAX routes are stored in commonajax.js
    3. Both have all routes named the same as the web page with the acception of address/index.vue which is called as 'details'
  3. Database
    1. This uses a mysql database (please ensure to update the .env file with your database information)
    2. Two tables
      1. Contacts
        • fields
          • firstName str
          • lastName str
          • email str
          • phone str
          • birthday date yyyy-mm-dd
      2. Addresses
        • fields
          • number int
          • street str
          • city str
          • state str
          • zip int
          • contact_id (foreign key to the contact table)

Known Issues

  • still in development

Future work

  • Add user authentication
  • Add personal address books

Release Notes

1.0.0

unreleased

Contact us

Carlos Aragon

addressbook-lv's People

Contributors

truslide12 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.