Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cyphernyx/csharp-employee-badgemaker

Console app that creates employee security badges. Developed using C# and .NET framework to import libraries that let you read and write to the file system, query APIs, and generate images.
https://github.com/cyphernyx/csharp-employee-badgemaker

asp-net csharp dotnet-core graphics-manipulation oop

Last synced: about 4 hours ago
JSON representation

Console app that creates employee security badges. Developed using C# and .NET framework to import libraries that let you read and write to the file system, query APIs, and generate images.

Awesome Lists containing this project

README

        

# Csharp-Employee-BadgeMaker
>.NET command line application

Console app that creates employee security badges. This application is developed using C# and .NET framework to import libraries that let you read and write to the file system, query APIs, and generate images.

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
![C#](https://img.shields.io/badge/csharp-%23239120.svg?style=for-the-badge&logo=csharp&logoColor=white)

## Table of Contents
- [Getting Started](#getting-started)
- [Screenshots](#screenshots)
- [APIs](#apis)
- [License](#license)
- [Contribute](#contribute)
- [Contact](#contact)

## Getting Started
To contribute, run or explore the codebase for this C# command line application, follow these steps below:

1. Clone the repository: `git clone https://github.com/CypherNyx/Csharp-Employee-BadgeMaker.git`
2. Open the project in VS Code (or a compatible IDE).
3. Navigate to the cloned directory in your file explorer.
4. Enter the following in the Command Prompt to run the application:
```
dotnet run
```
5. Make changes or improvements as needed.
6. Additional notes:
- **Prerequisites**: Ensure you have .NET Core SDK (or the appropriate .NET Framework version) installed on your machine. You can download it from https://dotnet.microsoft.com/download.
- **Exploring the code**: The main C# code files will be found in the Program.cs file within the src directory.


## Screenshots
### Data Input
Run the application and create a single employee (or multiple employees) at the command prompt to create a badge image. Don't forget to include the URL for the employee test photo, you can use the a place holder URL as https://placekitten.com/400/400 :

![data1](./data/data_input1.png)

### Badge Preview
You'll find your new badges neatly saved as PNG files within the `data` folder. They'll look just like this:

![holmesbadge](./data/7410_badge.png)

### Individual Badge Files:
Every employee will have their own unique badge, saved as a separate PNG file within the `data` folder. This makes it super easy to share, print, or use each badge individually.

![data2](./data/data_input2.png)

### Consolidated Employee Data:
To keep track of all employee information in one place, inside the `data` folder, you'll also find a handy CSV file named `employee.csv`. This file stores employee details in a clear, organized format.
![data3](./data/data_input3.png)

## APIs
The application utilizes the following APIs:
* [Random User API](https://randomuser.me/)

## Contributing
Pull requests are welcome. Please open an issue first to discuss any proposed changes or additions.

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

https://opensource.org/licenses/MIT

This project is open source and available under the MIT License.


## Questions
GitHub [CypherNyx](https://github.com/CypherNyx)

Email: [email protected]