Skip to content

The SVG Logo Maker is a command-line application built with Node.js that allows you to generate custom SVG logos.

License

Notifications You must be signed in to change notification settings

naturuplift/SVGLogoMaker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SVG Logo Maker


University of New Brunswick JavaScript - JavaScript - JavaScript -


Create custom SVG logos with this Node.js command-line application!

Description

The SVG Logo Maker is a command-line application built with Node.js that allows you to generate custom SVG logos. You can choose the logo's color, shape, and add text to create unique designs. The generated SVG logo can be saved to a .svg file for use in various projects.

Features

  • Choose from a variety of shapes and colors for your logo.
  • Add text to your logo.
  • Save the generated SVG logo to a .svg file.
  • Simple and user-friendly command-line interface (CLI).

Table of Contents

Demo Video

Open Demo video of README Generator

Installation

To use the SVG Logo Maker, follow these steps:

1. Clone this repository to your local machine:

git clone https://github.com/naturuplift/SVGLogoMaker

2. Navigate to the project directory:

cd SVGLogoMaker

3. Install the required dependencies:

npm install

Usage: How to use the SVG Logo Maker

Create a yellow triangular logo with blue text

Run the SVG Logo Maker in terminal with:

node index.js

Then answer questions in terminal:

  • Add Text: Enter text to be displayed on the logo up to three characters. i.e.: 'svg'
  • Select Text Color: Enter either alphabetic for color names or a valid hex color code. i.e.: 'blue'
  • Select Shape: Choose from various shapes for your logo, such a a circle, a square, or a triangle. i.e.: 'triangle'
  • Select Shape Color: Enter either alphabetic for color names or a valid hex color code. i.e.: 'yellow'

Sample terminal usage to generate SVG logo:

SVGLogoMaker logo generation

Then the application generates the SVG Logo 'logo.svg' and save SVG in application directory.

Sample generated SVG logo, a yellow trianglular shape with blue text 'svg':

SVGLogoMaker logo

Use Jest to Test Each Shape Class

Run the Jest test using command in terminal:

npm test

Sample terminal usage to test shape classes using Jest:

SVGLogoMaker Jest test

State Flow Diagram

For a visual representation of the sequence of actions involved in the svg logo maker, refer to the State Flow Diagram provided in the project documentation.

Feel free to reach out, contribute, or provide feedback to make the Password Generator Project even more robust and user-friendly!

Contributing

Contributions to this project are welcome. If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.

Happy logo designing with SVG Logo Maker!

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

The SVG Logo Maker is a command-line application built with Node.js that allows you to generate custom SVG logos.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published