ruthtech/profile-generator

This command-line application dynamically generates a PDF profile from a GitHub username.

Developer Profile Generator

This command-line application dynamically generates a PDF profile from a GitHub username.

Getting Started

All of the files can be loaded with your Git terminal. Copy the files to your local directory and type

node index.js.

Prerequisites

• Git terminal
• Node

Installing

1. Go to https://github.com/ruthtech/profile-generator and click on the "Clone or Download" button. 
2. Choose "Download ZIP". 
3. Unzip into a directory. If you're on Windows, open File Explorer and navigate to the download directory. Select the ZIP file, right click, and choose "Extract All". Accept the default location.
4. Once the file is unzipped, navigate to profile-generator-master.
5. If you don't have the prerequisites installed, type the following:
   * npm install inqiurer
   * npm install axios
   * npm install html-pdf
6. Then use your Git terminal to execute index.js. 

Running the tests

No automated test suite has been created for these files.

Manual tests

1. Enter a colour that's supported ('green', 'blue', 'pink' or 'red')
2. Enter a colour that's unsupported
3. Enter a name that can be looked up (e.g. octocat)
4. Enter a name that doesn't exist (e.g. unljwefsdfsdagsergsef)
5. Regenerate the same user name with a different supported colour. Ensure that it's generated.

Deployment

To deploy this on a live system, copy all of the files to your computer. This is a command-line tool, not one that runs in the browser. There are no live pages to demonstrate.

Built With

• [Visual Studio Code] https://code.visualstudio.com/docs/setup/setup-overview
• [Visual Studio Code Extension "Open in Browser"]
  • Open VS Code.
  • Open the extensions pane and search for open in browser.
  • Select the version written by TechER and click Install.
• Eclipse (https://www.eclipse.org/downloads/)
  • An IDE alternative to Visual Studio Code
• Git Terminal (https://git-scm.com/downloads)
• Node (https://nodejs.org/en/download/)
  • inqiurer
  • axios
  • html-pdf
• Icons: * blog icon from https://pngtree.com/so/blog-icon * gitHub icon from https://github.com/logos * location icon from https://www.iconsdb.com/red-icons/location-icon.html

Contributing

This project is not open to contributions.

Versioning

This project does not use versions at this time.

Authors

Ruth Lee

License

MIT

Acknowledgments

Thanks to the following:

• U of T Coding Bootcamp (https://bootcamp.learn.utoronto.ca/coding/)
• Eclipse (https://www.eclipse.org/downloads/)
• Node (https://nodejs.org/en/download/)
  • inqiurer
  • axios
  • html-pdf
• Git Terminal (https://git-scm.com/downloads)
• Icons: * blog icon from https://pngtree.com/so/blog-icon * gitHub icon from https://github.com/logos * location icon from https://www.iconsdb.com/red-icons/location-icon.html