Giter Site home page Giter Site logo

svg-logo-generator's Introduction

SVG Logo Generator

License

Description

When creating a website or application, you may need a logo to represent your project or webpage. This Node.js command-line application will take in user input to generate a logo and save it as an SVG file. The application prompts the user to select a color and shape, provide text for the logo, and save the generated SVG to a .svg file.

Table of Contents

Walkthrough Video

Click the following link to view a walktrhough video on the usage of the application: SVG Logo Generator Video

Installation

  1. Clone this repository to your local machine. (For reference, visit the Cloning a Repository GitHub Docs article.)
  2. Run npm install in your CLI to download the npm package dependencies.
  3. Run node index.js on your CLI to run the application.

Usage

When the program is initialized, you will be prompted to answer a series of questions about the logo you want. This includes the text, text color, shape, and shape color.

Once all the questions have been answered, fs.writeFile() is used to generate an svg file based on your answers. The generated file will be written to the relative examples/ directory.

Screenshot of CLI on Use

"Screenshot of CLI"

Contributing

To make contributions to this project:

  1. Fork the repository
  2. Make some commits to improve the application
  3. Open a Pull Request on GitHub
  4. From there, we can discuss your changes and merge the pull request once your contributions have been approved!

Testing

I've written some test scripts for this project, which can be found in the test/ directory.
Before you run the test suites, ensure that you have downloaded the project package dependencies in the Installation section.
When you're ready to run the tests, go to your CLI and run npm test.

License

This GitHub repository is licensed under the MIT license. Please refer to the license documentation here.

Questions

This project was created by dymoy.
For any related questions, please contact me via email at [email protected].

svg-logo-generator's People

Contributors

dymoy avatar

Watchers

 avatar

svg-logo-generator's Issues

User can enter color keyword or hexadecimal number

AS a freelance web developer
I WANT to generate a simple logo for my projects
SO THAT I don't have to pay a graphic designer

GIVEN a command-line application that accepts user input
WHEN I am prompted for the text color
THEN I can enter a color keyword (OR a hexadecimal number)

User can enter color keyword or hex number for shape's color

AS a freelance web developer
I WANT to generate a simple logo for my projects
SO THAT I don't have to pay a graphic designer

GIVEN a command-line application that accepts user input
WHEN I am prompted for the shape's color
THEN I can enter a color keyword (OR a hexadecimal number)

`logo.svg` file is created when user answers all prompts

AS a freelance web developer
I WANT to generate a simple logo for my projects
SO THAT I don't have to pay a graphic designer

GIVEN a command-line application that accepts user input
WHEN I have entered input for all the prompts
THEN an SVG file is created named logo.svg

User can enter up to 3 characters

AS a freelance web developer
I WANT to generate a simple logo for my projects
SO THAT I don't have to pay a graphic designer

GIVEN a command-line application that accepts user input
WHEN I am prompted for text
THEN I can enter up to three characters

`logo.svg` is a 300x200 px image that matches the user-entered criteria

AS a freelance web developer
I WANT to generate a simple logo for my projects
SO THAT I don't have to pay a graphic designer

GIVEN a command-line application that accepts user input
WHEN I open the logo.svg file in a browser
THEN I am shown a 300x200 pixel image that matches the criteria I entered

User can enter circle, triangle, or square for logo shape

AS a freelance web developer
I WANT to generate a simple logo for my projects
SO THAT I don't have to pay a graphic designer

GIVEN a command-line application that accepts user input
WHEN I am prompted for a shape
THEN I am presented with a list of shapes to choose from: circle, triangle, and square

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.