Noemiegrau / team-profile-generator

A team profile generator using Nodejs, OOP and TDD (Jest tests).

Team Profile Generator

Table of contents

• Description of the project
• Technologies used
• Usage
• Installation
• Link URL to GitHub Repository

Description of the project

This project is a team profile generator using Nodejs, OOP and TDD (Jest). The user is prompted with questions in the terminal. The answers will be used to fill the HTML page that will then be generated by the app.

Technologies used

Project is created using:

• HTML
• CSS
• JavaScript
• Nodejs
• Inquirerjs
• OOP
• TDD (jest tests)

Usage

small.video.team.profile.gen.mov

Final app should look something like this:

Installation

Here are some guidelines for installing the project on your local machine in order to be able to try it:

1. Since Node.js applications don't have a front end, clone or download the repository to your own local machine and run it from your command line.

2. Then, make sure that your repo includes a package.json with the required dependencies. You can create one by running npm init in your command line.

3. Run npm i or npm install in order to download all the dependencies. Make sure to also download Inquirer.js by entering npm install inquirer in your terminal in the root directory of the project. Learn more about this package on npm documentation.

4. Run node index.js or node index in your terminal to launch the application, the first question will appear in your terminal.

5. To make sure the Jest tests work, run npm run test and inspect what the CLI returns.

6. Enjoy and don't hesitate to contribute! 🙂

Link URL to GitHub Repository

https://github.com/Noemiegrau/team-profile-generator