alexgeis / security-badge-creator

Security Badge Creator

CLI tool to create employee badge images from employee info (or API)
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

Built With

• C#

(back to top)

Getting Started

Instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

First, install the .NET environment version 6+.

Installation

1. Clone the repo

   git clone https://github.com/alexgeis/security-badge-creator.git

2. Install .NET environment (https://dotnet.microsoft.com/en-us/download)
3. Run "dotnet run" to start the application

   cd CatWorx.BadgeMaker
   dotnet run

(back to top)

Usage

Simply follow the CLI prompts to add employee info and you'll find created badges in the CatWorx.BadgeMaker/data/ directory as .png assets.

(back to top)

Roadmap

• - upload images to an online service like Google Drive or Imgur (https://apidocs.imgur.com/)
• - save employee info in a MySQL database
• - add a default photo if one doesn't exist for any given user
• - input for company name

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Any contributions you make are greatly appreciated.

Please try to create bug reports that are:

• Reproducible. Include steps to reproduce the problem.
• Specific. Include as much detail as possible: which version, what environment, etc.
• Unique. Do not duplicate existing opened issues.
• Scoped to a Single Bug. One bug per report.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Alex Geis - [e-mail]

Project Link: https://github.com/alexgeis/security-badge-creator

(back to top)

Acknowledgments

Helpful resources and kudos.

• Random User Generator API

(back to top)