CHARGENIE

A Character Generator App

Built with the tools and technologies:

Table of Contents

• Overview
• Features
• Learning and Implementation of Zustand
• Repository Structure
• Getting Started
  • Installation
  • Usage
• Contributing
• Acknowledgments

---

Overview

The Character Generator App is your ultimate tool for crafting unique characters tailored to your imagination. With extensive customization options, users can select from various hairstyles, facial features, background, and accessories. The app also includes a random generation feature for spontaneous character ideas. Save your creations in a personal library and easily share them with friends. Regular updates ensure fresh content, making character creation an exciting and ongoing adventure. Start designing your perfect character today!

---

Features

Customization Options: Choose from diverse hairstyles, facial features, hairstyles, background, and accessories. Random Generation: Create unexpected characters with a single tap. Save and Share: Keep your favorite designs and share them with friends. Regular Updates: Enjoy new features and options with ongoing updates.

---

Learning and Implementation of Zustand

This project marks my first experience with Zustand for state management. Diving into its concepts and functionality has been a valuable learning journey, enhancing my understanding of managing application state effectively. Implementing Zustand has significantly improved the performance and maintainability of the Character Generator App.

---

Repository Structure

└── CharGenie/
    ├── README.md
    ├── package-lock.json
    ├── package.json
    ├── public
    │   ├── favicon.ico
    │   ├── index.html
    │   ├── logo192.png
    │   ├── logo512.png
    │   ├── manifest.json
    │   └── robots.txt
    └── src
        ├── App.css
        ├── App.js
        ├── components
        │   ├── AvatarCustomization
        │   ├── Buttons
        │   ├── Categories
        │   ├── Store
        │   └── assets
        ├── index.css
        └── index.js

---

Getting Started

Installation

Build the project from source:

1. Clone the CharGenie repository:

❯ git clone https://github.com/Zarrarabid/CharGenie

2. Navigate to the project directory:

❯ cd CharGenie

3. Install the required dependencies:

❯ npm install

Usage

To run the project, execute the following command:

❯ npm start

---

Contributing

Contributions are welcome! Here are several ways you can contribute:

• Report Issues: Submit bugs found or log feature requests for the CharGenie project.
• Submit Pull Requests: Review open PRs, and submit your own PRs.
• Join the Discussions: Share your insights, provide feedback, or ask questions.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/Zarrarabid/CharGenie

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

---

Acknowledgments

I would like to express my gratitude to BigDevSoon for inspiring the development of this Character Generator App. Their innovative ideas and resources provided a solid foundation for this project. Special thanks to the community for their feedback and support, which helped shape the app into a user-friendly and creative tool. Your contributions have been invaluable in bringing this vision to life.

---