https://github.com/ramirezmz/contact-manager

Simple contact manager in your terminal
https://github.com/ramirezmz/contact-manager

chalk command-line eslint inquirerjs javascript

Last synced: 3 months ago
JSON representation

Simple contact manager in your terminal

• Host: GitHub
• URL: https://github.com/ramirezmz/contact-manager
• Owner: ramirezmz
• Created: 2023-04-09T00:12:38.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-05-06T01:25:39.000Z (about 3 years ago)
• Last Synced: 2025-03-16T17:43:17.207Z (over 1 year ago)
• Topics: chalk, command-line, eslint, inquirerjs, javascript
• Language: TypeScript
• Homepage:
• Size: 245 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Contact Manager project

![Contact preview](doc/create-account.gif)

This project calls contact manager, and it's special! why? the front end is a command line interface (CLI). Also, the backend is a REST API. You don't need to up the backend, because it's already up in the cloud.

You just need to run the front end (cli) in your terminal and enjoy!

In this project, you can do the following:

- Create an account

- Login in your account

- Create a contact

- Read the contacts

- Remove a contact

- Update a contact

- Logout

## Demo

![Contact Manager](doc/screen-page.png)

## Tools

This project uses the following tools:

- [Node.js](https://nodejs.org/en/)

- [Chalk](https://www.npmjs.com/package/chalk)

- [Fliget](https://www.npmjs.com/package/figlet)

- [inquirer](https://www.npmjs.com/package/inquirer)

- [Gradient-string](https://www.npmjs.com/package/gradient-string)

- [MongoDB](https://www.mongodb.com/)

- [Mongoose](https://mongoosejs.com/)

- [Docker](https://www.docker.com/)

- [Mocha](https://mochajs.org/)

- [Sinon](https://sinonjs.org/)

## How to run

1. Clone the repository

2. Enter the project directory `cd contact-manager/command-line`

3. Install the dependencies with `npm install`

4. Run the application with `npm run dev`