A simple pixelart avatar generator

View Demo · Report Bug · Request Feature

About The Project

This project was born for fun, as an experiment in creating faces using pixel art

Built With

• 
• 

Getting Started

Prerequisites

• You must have npm installed on your machine in order to run the project.

  npm install npm@latest -g

• If you want to generate the .png you must also configure the backend service. Follow the instructions here to setup AvatR API backend.

Installation

1. Clone the repo

   git clone https://github.com/zanzarone/avatr.git

2. Enter in the project directory

   cd avatr

3. Install NPM packages

   npm install

4. (Optional) Create an .env file in the root of the project and enter the local(or remote) address of the backend service

   REACT_APP_API_ENDPOINT = "ENTER BACKEND ADDRESS";

5. Run the project

   npm start

(back to top)

Roadmap

• Add Additional pixelart Templates
• Add support for others file type

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

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

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

Samuele Scatena - @LinkedIn - [email protected]

Project Link: https://github.com/zanzarone/avatr

(back to top)