{"id":17247021,"url":"https://github.com/csantiago132/node-address-book","last_synced_at":"2026-01-19T07:32:54.313Z","repository":{"id":41809571,"uuid":"151454014","full_name":"csantiago132/node-address-book","owner":"csantiago132","description":"A CLI application that will allow you to store and retrieve contacts from an address book thru Node.js","archived":false,"fork":false,"pushed_at":"2022-12-04T00:13:37.000Z","size":607,"stargazers_count":1,"open_issues_count":15,"forks_count":0,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-02-12T14:15:09.042Z","etag":null,"topics":["cli","javascript","nodejs","postgresql","sequelizejs"],"latest_commit_sha":null,"homepage":"","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/csantiago132.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":"2018-10-03T17:38:14.000Z","updated_at":"2023-03-24T05:39:30.000Z","dependencies_parsed_at":"2023-01-22T17:30:29.081Z","dependency_job_id":null,"html_url":"https://github.com/csantiago132/node-address-book","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csantiago132%2Fnode-address-book","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csantiago132%2Fnode-address-book/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csantiago132%2Fnode-address-book/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csantiago132%2Fnode-address-book/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/csantiago132","download_url":"https://codeload.github.com/csantiago132/node-address-book/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247457572,"owners_count":20941902,"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","javascript","nodejs","postgresql","sequelizejs"],"created_at":"2024-10-15T06:35:46.894Z","updated_at":"2026-01-19T07:32:54.300Z","avatar_url":"https://github.com/csantiago132.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Codacy Badge](https://api.codacy.com/project/badge/Grade/7afd2cdf1338428d9da297b38918d683)](https://app.codacy.com/app/csantiago132/node-address-book?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=csantiago132/node-address-book\u0026utm_campaign=Badge_Grade_Dashboard)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)\n[![CircleCI](https://circleci.com/gh/csantiago132/node-address-book.svg?style=svg)](https://circleci.com/gh/csantiago132/node-address-book)\n\n# Node Address Book\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/csantiago132/node-address-book/develop/preview.png\" alt=\"node-address-book preview\"/\u003e\u003c/p\u003e\n\nA CLI application that will allow you to store and retrieve contacts from an\naddress book thru Node.js using Sequelize on a PostgreSQL database.\n\n## Prerequisites\n\n\u003e - PostgreSQL\n\u003e - Yarn \u003e= 1.5.x\n\u003e - Node \u003e=10.x\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your\nlocal machine for development and testing purposes.\n\n1. Clone this repo using\n   `git clone https://github.com/csantiago132/node-address-book.git`\n\n2. Move to the appropriate directory: `cd node-address-book`\n\n3. Run `yarn install` to install dependencies\n\n4. If you don't have Postgres installed on your computer, please\n   [download](https://www.openscg.com/bigsql/postgresql/installers.jsp/) and\n   install using the installer for your operating system\n\n5. Create the databases for the application by running the `createdb` command:\n\n- A database to use in the application\n- a database for testing the application\n\n```bash\n  createdb -U postgress -w addressBook\n  createdb -U postgress -w addressBookTest\n```\n\n6. start your database by running the following command:\n   `pg_ctl -D /usr/local/var/postgres[VERSION NUMBER HERE] start`\n\n- If your postgres folder does not have a version number, run\n  `pg_ctl -D /usr/local/var/postgres start`\n\n7. On the terminal, note the port number where Postgres listens for requests\n\n- Go to `db/config/config.json` and place that number in the `port` property:\n\n```json\n  \"development\": {\n    \"port\": \"YOUR_PORT_NUMBER_HERE\",\n```\n\n- **Value has to be a Number, not a String**\n\n8. Run the migration scripts `yarn run migrateDb` on the terminal\n\n- this will run `sequelize db:migrate \u0026\u0026 sequelize db:migrate --env test`\n\n**Your database is now ready to accept contacts**\n\n## Features\n\n- [x] CircleCI integration\n- [x] Jazmine test environment\n- [x] Husky pre-commit hooks (to lint and format the code)\n- [x] Add new contacts to the database\n- [x] View all contacts stored on the database\n- [x] Search for contacts stored on the database\n- [x] Gets you current date and time\n\n## TODO List\n\nIn the near future, I want to add:\n\n- [ ] Increase and refactor tests suites\n- [ ] Add coverage reports thru Coveralls\n- [ ] Build a front-end and create an UI for the application\n\n## Built With\n\n- [NodeJS](https://github.com/nodejs/node)\n- [node-postgres](https://github.com/brianc/node-postgres)\n- [inquirer](https://github.com/SBoudrias/Inquirer.js/)\n- [pg-hstore](https://github.com/scarney81/pg-hstore)\n- [Sequelize](https://github.com/sequelize/sequelize#readme)\n- [PostgreSQL](https://www.openscg.com/bigsql/postgresql/installers.jsp/)\n\n## Versioning\n\nI use [SemVer](http://semver.org/) for versioning. For the versions available,\nsee the\n[tags on this repository](https://github.com/csantiago132/node-address-book/releases).\n\n## Authors\n\n- **Carlos Santiago** - _Initial work_ -\n  [csantiago132](https://github.com/csantiago132)\n\n## License\n\nThis project is licensed under the MIT License - see the\n[LICENSE.md](LICENSE.md) file for details.\n\n## Acknowledgments\n\n- **Cory Trimm** - _for mentoring_ - [github](https://github.com/ctrimm)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsantiago132%2Fnode-address-book","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcsantiago132%2Fnode-address-book","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsantiago132%2Fnode-address-book/lists"}