https://github.com/mauryiv/logo-generator

https://github.com/mauryiv/logo-generator

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/mauryiv/logo-generator
• Owner: MauryIV
• Created: 2024-03-07T23:32:01.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-03-07T23:38:47.000Z (10 months ago)
• Last Synced: 2024-10-15T05:23:36.592Z (3 months ago)
• Language: JavaScript
• Size: 10.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# Logo Generator 



## Description

This project prompts a few questions to the user through the command line to create a simple svg doc for a personalized logo.

## Table of Contents

- [Title](#title)

- [Description](#description)

- [Badges](#badges)

- [Visuals](#visuals)

- [Installation](#installation)

- [Usage](#usage)

- [Tests](#tests)

- [Questions](#questions)

- [Roadmap](#roadmap)

- [Contributing](#contributing)

- [Authors and Acknowledgment](#acknowledgment)

- [License](#license)

- [Project Status](#status)



## Badges

![Maury Hughes IV](https://img.shields.io/badge/Maury%20Hughes%20IV-5A2BE2)

![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)



## Installation

Would need to install the dependencies listed in the package.json as well as the devDependencies there if user wants to test as well.



## Usage

This code is for creating simple logos for yourself. Please check out the visuals for examples.



## Visuals

![Triangle Example](https://github.com/MauryIV/logo-generator/assets/146037880/b7cd20a9-5690-4c10-933a-d367b90ae329)

![Circle Example](https://github.com/MauryIV/logo-generator/assets/146037880/f02f75ee-44f8-47c7-9652-cd3364407148)

![Square Example](https://github.com/MauryIV/logo-generator/assets/146037880/3f73b060-a4dd-402c-8c27-f3594948bbc5)

[Video Walkthrough](https://drive.google.com/file/d/1qBPkcFXRKSATATdJG3rh7ZiRNE29CCj6/view)



## Tests

I have a few test listed in the code. If you run jest in the command line, that will test the output of the files. I also cover this in the walkthrough video.



## Questions

If you have any questions about the contents. Please feel free to reach out!

Here is my [Github](https://github.com/MauryIV) as well as my email .



## Roadmap

I would like to expand this in the future to add more interesting shapes, fonts, background. Make it more complex in its output.



## Contributing

I'd absolutley love and suggestions and what all y'all would like to see or want to add. Please feel free to reach out.



## Authors and Acknowledgment

I wrote this from scratch but I did use the tools given to me from DU's coding bootcamp.



## License

MIT License © 2024 Maury Hughes IV

Please refer to this link, [License: MIT](https://opensource.org/licenses/MIT) for more information.



## Project Status

Complete, for now.

[back to top](#title)