{"id":13941623,"url":"https://github.com/SanctumLabs/contact-manager-cli","last_synced_at":"2025-07-20T04:32:08.511Z","repository":{"id":40509636,"uuid":"111060002","full_name":"SanctumLabs/contact-manager-cli","owner":"SanctumLabs","description":"Manage your contacts from your command line","archived":false,"fork":false,"pushed_at":"2022-10-06T19:21:57.000Z","size":1004,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-08-09T02:16:03.549Z","etag":null,"topics":["cli","cloud-functions","firebase","firebase-cloud-functions","firebase-database","node-cli"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SanctumLabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-11-17T04:59:11.000Z","updated_at":"2022-01-04T15:28:25.000Z","dependencies_parsed_at":"2023-01-19T12:45:36.095Z","dependency_job_id":null,"html_url":"https://github.com/SanctumLabs/contact-manager-cli","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SanctumLabs%2Fcontact-manager-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SanctumLabs%2Fcontact-manager-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SanctumLabs%2Fcontact-manager-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SanctumLabs%2Fcontact-manager-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SanctumLabs","download_url":"https://codeload.github.com/SanctumLabs/contact-manager-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226733203,"owners_count":17673162,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","cloud-functions","firebase","firebase-cloud-functions","firebase-database","node-cli"],"created_at":"2024-08-08T02:01:22.899Z","updated_at":"2024-11-27T10:31:11.803Z","avatar_url":"https://github.com/SanctumLabs.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Contact Manager CLI\n\nSmall command line tool to create contacts from your terminal. Utilizes [Google Cloud Functions](https://cloud.google.com/functions/) for HTTP triggers, [Firebase](https://firebase.google.com) for persistent storage and plain old [NodeJS](https://nodejs.org/en/).\n\n## Getting Started\n\nThese simple steps will get you a working copy of the application.\n\n```bash\n$ git clone https://github.com/Wyvarn/contact-manager-cli.git\n```\n\u003e this will clone the repo and create a contact-manager-cli directory\n\nIf you prefer a different name for the project\n\n```bash\n$ git clone https://github.com/Wyvarn/contact-manager-cli ~/\u003cYOUR_OTHER_NAME_FOR_PROJECT\u003e\n```\n\n## Requirements\n\nYou will need a couple of things to get started:\n\n1. *NodeJS and npm*\n\n   Ensure you have NodeJS installed on your environment. You can get installation instructions from [here](https://nodejs.org/en/download/)\n\n2. *Firebase CLI*\n   \n    Get firebase-tools installed on your development environment. This will be used to manage the project and configure Cloud functions.\n\n    ```bash\n    $ npm install -g firebase-tools\n    ```\n\n    More instructions on using firebase-tools can be found [here](https://firebase.google.com/docs/cli/)\n\n## Setting up\n\nSetting up the project is easy, once you have all the requirements checked, then you can setup as follows:\n\n``` bash\n$ npm install\n# if using yarn\n$ yarn install\n```    \n\u003e This will install all the dependencies you need in node_modules/ directory\n\nOnce you have installed dependencies here, change directory into `firefunctions/functions` and install dependencies there too\n\n```bash\n$ cd firefunctions/functions\n$ npm install # or yarn install\n```\n\nNow you can use `firebase-tools` to setup your project with firebase\n\n``` bash\n$ firebase login # logs you into firebase console\n```\n\n## Running the app\n\nYou will need to setup a project on Firebase console after which you can enable the project in the firefunctions directory.\n\n```bash\n$ cd firefunctions\n$ firebase use \u003cPROJECT_ID\u003e\n```\n\nNext step is to deploy functions:\n\n```bash\n$ npm run deploy\n```\n\u003e Run this command inside the `firefunctions` directory \n\nAfter which you can take the CLI for a run.\n\n```bash\n$ cd .. # if in the firefunctions directory\n$ npm run build\n$ npm install -g\n$ npm link # not necessary\n``` \n\nThis will run a build and transpile the code before setting it in the build/ directory. You can then install it globally and link if necessary.\n\nOne thing to keep in mind: During development, any change you make in the project will not be visible if you simply execute the contact command with the given options. If you run `which contact-manager`, you will realize that the path of contact is not the same as the project path in which you are working. To prevent this, simply run `npm link` in your project folder. This will automatically establish a symbolic link between the executable command and the project directory. Henceforth, whatever changes you make in the project directory will be reflected in the contact command as well.\n\n[![forthebadge](http://forthebadge.com/images/badges/uses-js.svg)](http://forthebadge.com)\n[![forthebadge](http://forthebadge.com/images/badges/built-with-grammas-recipe.svg)](http://forthebadge.com)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSanctumLabs%2Fcontact-manager-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSanctumLabs%2Fcontact-manager-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSanctumLabs%2Fcontact-manager-cli/lists"}