README.md

Contacts App

Contact management tool built using React, Firebase and TypeScript.

Table of Contents

• Setup
• Usage
• Models
• License

Setup

Install dependencies.

npm install

Usage

Format

Format code using Prettier.

npm run format

Linting

Lint code using ESLint.

npm run lint

Testing

Run tests using Jest testing framework.

npm test

Models

Contact

Contact model structure containing example data.

{
  "name": {
    "firstName": "John",
    "lastName": "Doe"
  },
  "addresses": [
    {
      "type": "home",
      "value": {
        "city": "New York City",
        "country": "US",
        "street": "Main Street 1",
        "zip": "12345"
      }
    }
  ],
  "emails": [
    {
      "type": "home",
      "value": "john.doe@gmail.com"
    }
  ],
  "phones": [
    {
      "type": "home",
      "value": "+1 234 56789"
    }
  ]
}

License

MIT © Marco Biedermann