To install, please clone this repository to your computer using the following steps:
- Click the "Code" dropdown menu and copy the SSH URL.
- Open your terminal and navigate to the directory you would like to clone this repository into.
- Type "git clone ", replacing with your copied SSH URL. You can substitute an SSH URL with an HTTPS URL.
- Press enter.
This is a node-based program that generates an SVG logo based on user input into the command line. It utilizes Inquirer for input collection, and Jest for unit testing.
The program allows the user to input a 3 character text, the text color, the logo shape, and the logo color. For the shape, the user can pick between a triangle, circle, and square.
An SVG file based on the user's input then generates in the "examples" folder.
To run the program, navigate to the SVG-Logo-Generator folder and enter "node index.js" into your local terminal. Follow the steps as prompted.
Once all the prompts have been answered, a message will be displayed stating the SVG file has been generated. It will also display the pathway to the subdirectory "examples" where your program was generated.
Note - if you generate another SVG after creating your first one, it will overwrite the SVG that already exists in your utils folder. So please save it in a separate folder if you wish to create another one.
To run testing, enter "npm test" into the console.
Please see this video demo. If unable to view, you can also find the video in assets/videos/screenrecording.mov.
When contributing to this repository, please reach out to me via e-mail to discuss the change you would like to make first. I am open to ideas both with regards to new inputs the user can enter to further develop the logo and new tests that can be run.
This project is licensed under the MIT License. For more information, please see the MIT License.
This program was created by Jacob McAuliffe for the UC Berkeley eDX Coding Boot Camp.
In the future, I would like to incorporate other abilities, so users can further customize their SVG logos. Such features could include adding additional text, incorporating images, and even limited animation. Additionally, I'm eager to incorporate the ability to create multiple SVGs without overwriting the initial one in the examples directory.
If you have further questions, you can reach me at [email protected].
GitHub Account: jacobmca