https://github.com/philipszdavido/contact-manager
A command-line Node.js app powered by TypeScript, Google Cloud Functions and Firebase for managing contacts
https://github.com/philipszdavido/contact-manager
cloud-functions firebase firebase-functions firebase-realtime-database javascript nodejs typescript
Last synced: 6 days ago
JSON representation
A command-line Node.js app powered by TypeScript, Google Cloud Functions and Firebase for managing contacts
- Host: GitHub
- URL: https://github.com/philipszdavido/contact-manager
- Owner: philipszdavido
- Created: 2017-10-31T00:30:21.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-11-08T16:57:18.000Z (over 7 years ago)
- Last Synced: 2024-11-27T10:36:13.702Z (5 months ago)
- Topics: cloud-functions, firebase, firebase-functions, firebase-realtime-database, javascript, nodejs, typescript
- Language: JavaScript
- Homepage:
- Size: 32.2 KB
- Stars: 21
- Watchers: 2
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - philipszdavido/contact-manager - A command-line Node.js app powered by TypeScript, Google Cloud Functions and Firebase for managing contacts (JavaScript)
README
# Contact Manager
This is a command-line contact management system app built with TypeScript, Node.js, Firebase Realtime Database and Firebase Cloud Functions.
### Technologies:
- JavaScript
- Node.js
- TypeScript
- Firebase
- Firebase Cloud Functions
### Features
- Add a contact
- Delete a contact
- View a contact
- View all contacts
### Installation
* Git clone this repo [here](https://github.com/philipszdavido/contact-manager).
* install ts-node globally `npm i ts-node -g` to be able to run the `ts` scripts directly.
* Move into the folder
```sh
cd contact-manager
```
* Run `npm install` to install node dependencies.
### Usage
Usage: [options] [command]
Contact Management System
Options:
-V, --version output the version number
-h, --help output usage information
Commands:
addContact|a Add a contact
getContact|g Get Contact
updateContact|u Update Contact
deleteContact|d Delete a contact
getContactList|l Get Contact List
## USING THE APP
**_If you want to run the JavaScript code, First run ``` npm link ```._**
### Adding a contact
###### TypeScript
```sh
ts-node contact a
```
###### JavaScript
```sh
contact a
```
### Deleting a contact
###### TypeScript
```
ts-node contact d
```
###### JavaScript
```sh
contact d
```
### Viewing all contacts
###### TypeScript
```
ts-node contact l
```
###### JavaScript
```sh
contact l
```
### Viewing a contact
###### TypeScript
```sh
ts-node contact g
```
###### JavaScript
```sh
contact g
```
### Contribute
1. Fork this repository
2. Clone it to your local machine
3. Create a branch for the feature you want to implement
4. Push your changes to your repository
5. Submit a pull request
- Issue Tracker: https://github.com/philipszdavido/contact-manager/issues
- Source Code: https://github.com/philipszdavido/contact-manager
### Support
If you are having issues, please let me know.
Mail me at: [email protected]