Solution: Ethan Alfaro, Jordi Arnau, Ernest Duocastella

README.md

@@ -1,4 +1,4 @@
-`#node.js` `#master-in-software-engineering`
+`#node.js` `#master-in-software-engineering` `CLI`
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 
@@ -8,156 +8,62 @@
 
 # Assembler School: Node.js MovieDB CLI App <!-- omit in toc -->
 
-In this project you will learn how to create a cli app with Node.js.
+In this project we have developed a CLI program with node.js that is able to run using a terminal application.
+The program is connecting to a third-party API to show the data returned and store it in the local system.
 
-## Table of Contents <!-- omit in toc -->
-
-- [Getting Started](#getting-started)
-- [The Project](#the-project)
-- [Project requirements](#project-requirements)
-- [Project delivery](#project-delivery)
-- [Resources](#resources)
-
-## Getting Started
-
-These instructions will get you a copy of the project up and running on your
-local machine for development and testing purposes.
-
-See deployment for notes on how to deploy the project on a live system.
-
-### The repository
-
-First, you will need to `clone` or `fork` the repository into your Github
-account:
-
-<img src="https://docs.github.com/assets/images/help/repository/fork_button.jpg" alt="Fork on GitHub" width='450'>
-
-```
-$ git clone https://github.com/assembler-school/node-moviedb-cli.git
-```
+## Repository <!-- omit in toc -->
 
-## Contents and Branches Naming Strategy <!-- omit in toc -->
+Project created from the Assembler School repository _node-moviedb-cli.git_:
 
-The repository is made up of several branches that include the contents of each
-section.
+https://github.com/assembler-school/node-moviedb-cli.git
 
-The branches follow a naming strategy like the following:
-
-- `main`: includes the main contents and the instructions
-- `assembler-solution`: includes the solution
-
-### Fetching All the Branches
-
-In order to fetch all the remote branches in the repository, you can use the
-following command:
-
-```sh
-$ git fetch --all
-```
+## Technologies used <!-- omit in toc -->
 
-### List Both Remote Tracking Branches and Local Branches
+\* JavaScript  
+\* NodeJS  
 
-```sh
-$ git branch --all
-```
+## Table of Contents <!-- omit in toc -->
 
-Then, you can create a local branch based on a remote branch with the following
-command:
+- [Main objectives](#main-objectives)
+- [Installing](#installing)
+- [Resources](#resources)
+- [Authors](#authors)
 
-```sh
-$ git checkout -b <new_branch_name> <remote_branch_name>
-```
+## Main objectives
 
-### Installing
+* Learn how to connect to a third party API using node.js
+* Learn how to implement a CLI program using node.js
+* Learn how to work with the filesystem apis of node.js
+* Learn how to interact with a CLI program and develop a menu that users can use to know how to execute the program
 
-First, you will need to install the dependencies with: `npm install`.
+## Installing
+First, you will need to install the dependencies with: npm install.
 
 Run the following command in your terminal after cloning the main repo:
 
-```sh
+```
 $ npm install
 ```
 
-### Running the Tests
-
-The tests that validate your solution can be executed by runing the following
-command:
+Next you can install the general command _moviedb_ so you can use it:
 
 ```
-$ npm run test
+$ npm install -g
 ```
 
-### Git `precommit` and `prepush` Hooks
-
-In the `assembler-solution` branch you can see an implementation of these tools
-if you'd like to use them.
-
-## Deployment <!-- omit in toc -->
-
-In this pill we won't deploy the app.
-
-## Technologies used <!-- omit in toc -->
-
-- `Node.js`
-- `eslint`
-- `prettier`
-- `lint-staged`
-- `husky`
-
-## The Project
-
-In this project you will build a cli app similar to the following screenshot.
-
-<img src="src/img/app-view.png">
-
-## Project requirements
-
-This is an overview of the main requirements of this project. The exact ones are
-found in the doc that the academic team will provide you.
-
-- You must follow all the instructions of the project step-by-step
-- You should always try to solve them by yourself before asking for help
-- You should always help your team members and fellow students of the master so
-  that you can all learn together and become better software developers and team
-  members
-- You must finish all the steps that are marked as `Required`
-- Once you are done, you can move on to the optional ones that are marked as
-  `Extra 💯`
-
-## Project delivery
-
-To deliver this project you must follow the steps indicated in the document:
-
-- [Submitting a solution](https://www.notion.so/Submitting-a-solution-524dab1a71dd4b96903f26385e24cdb6)
+The project is ready for you to play with it!
 
 ## Resources
 
-- See the document we provide
-
-## License <!-- omit in toc -->
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
-for details
-
-## Contributors ✨ <!-- omit in toc -->
-
-Thanks goes to these wonderful people
-([emoji key](https://allcontributors.org/docs/en/emoji-key)):
-
-<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
-<table>
-  <tr>
-    <td align="center"><a href="http://www.danilucaci.com"><img src="https://avatars.githubusercontent.com/u/19062818?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Dani Lucaci</b></sub></a><br /><a href="https://github.com/assembler-school/vanilla-js-project-template/commits?author=danilucaci" title="Code">💻</a> <a href="https://github.com/assembler-school/vanilla-js-project-template/commits?author=danilucaci" title="Documentation">📖</a> <a href="#example-danilucaci" title="Examples">💡</a> <a href="#tool-danilucaci" title="Tools">🔧</a></td>
-  </tr>
-</table>
-
-<!-- markdownlint-restore -->
-<!-- prettier-ignore-end -->
+\* [Build a CLI with Node.js](https://dev.to/rushankhan1/build-a-cli-with-node-js-4jbi)   
+\* [How to http request with Node.js and https.request](https://www.twilio.com/blog/2017/08/http-requests-in-node-js.html)  
+\* [Understanding module export in Node.js](https://www.sitepoint.com/understanding-module-exports-exports-node-js/)  
+\* [The MoviDB API](https://www.themoviedb.org/documentation/api)  
+\* [Ora Module](https://www.npmjs.com/package/ora)  
+\* [Commander Module](https://www.npmjs.com/package/commander)  
 
-<!-- ALL-CONTRIBUTORS-LIST:END -->
+## Authors
 
-This project follows the
-[all-contributors](https://github.com/all-contributors/all-contributors)
-specification. Contributions of any kind welcome!
+- [@Ethan-Alfaro](https://github.com/Ethan-Alfaro)  
+- [@Ernest-DT](https://github.com/Ernest-DT)
+- [@JordixArnau](https://github.com/JordixArnau)