Giter VIP home page Giter VIP logo

svg-logo-generator's Introduction

SVG-Logo-Generator

License: MIT

Table of Contents

Installation

To install, please clone this repository to your computer using the following steps:

  1. Click the "Code" dropdown menu and copy the SSH URL.
  2. Open your terminal and navigate to the directory you would like to clone this repository into.
  3. Type "git clone ", replacing with your copied SSH URL. You can substitute an SSH URL with an HTTPS URL.
  4. Press enter.

Description

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.

Usage

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.

Screenshot

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.

Screenshot

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.

Screenshot

Please see this video demo. If unable to view, you can also find the video in assets/videos/screenrecording.mov.

Contributions

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.

License

This project is licensed under the MIT License. For more information, please see the MIT License.

Credits

This program was created by Jacob McAuliffe for the UC Berkeley eDX Coding Boot Camp.

Tests

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.

Questions

If you have further questions, you can reach me at [email protected].

GitHub Account: jacobmca

svg-logo-generator's People

Contributors

jacobmca avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.