https://github.com/marcobiedermann/contacts

📒 Contacts Application
https://github.com/marcobiedermann/contacts

app contacts firebase react single-page-app typesript

Last synced: 4 months ago
JSON representation

📒 Contacts Application

• Host: GitHub
• URL: https://github.com/marcobiedermann/contacts
• Owner: marcobiedermann
• License: mit
• Created: 2018-07-31T18:33:48.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2023-03-14T22:12:21.000Z (over 2 years ago)
• Last Synced: 2025-04-05T13:32:23.601Z (7 months ago)
• Topics: app, contacts, firebase, react, single-page-app, typesript
• Language: TypeScript
• Homepage: https://contacts-app.netlify.com/
• Size: 4.89 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Contacts App

[![codecov](https://img.shields.io/codecov/c/gh/marcobiedermann/contacts)](https://codecov.io/gh/marcobiedermann/contacts)

[![dependencies Status](https://img.shields.io/david/marcobiedermann/contacts)](https://david-dm.org/marcobiedermann/contacts)

[![devDependencies Status](https://img.shields.io/david/dev/marcobiedermann/contacts)](https://david-dm.org/marcobiedermann/contacts?type=dev)

![GitHub Workflow Status](https://img.shields.io/github/workflow/status/marcobiedermann/contacts/CI)

[![Netlify Status](https://api.netlify.com/api/v1/badges/16b1212e-31a0-4415-aad4-df9d20d5217a/deploy-status)](https://app.netlify.com/sites/contacts-app/deploys)

Contact management tool built using React, Firebase and TypeScript.

## Table of Contents

- [Setup](#setup)

- [Usage](#usage)

- [Models](#models)

- [License](#license)

## Setup

Install dependencies.

```sh

npm install

```

## Usage

### Format

Format code using [Prettier](https://prettier.io/).

```sh

npm run format

```

### Linting

Lint code using [ESLint](https://eslint.org/).

```sh

npm run lint

```

### Testing

Run tests using [Jest](https://jestjs.io/) testing framework.

```sh

npm test

```

## Models

### Contact

Contact model structure containing example data.

```json

{

  "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](LICENSE) © [Marco Biedermann](https://github.com/marcobiedermann)