emoji-kitchen-api

Simple API to generate custom emojis using Google's project Emoji Kitchen

Hosted at https://emoji-kitchen-api.vercel.app/

Installation

To install the project and its dependencies, run:

npm install

Usage

To start the project locally, run:

npm start

This will start the project on http://localhost:3000 by default, or on the port specified in the PORT environment variable.

API Reference

• GET /emoji: Returns a list of all emojis.
• GET /emoji/:emoji/combinations: Returns a list of emoji combinations for a specific emoji.
• GET /mix/random: Returns a random emoji mix.
• GET /mix/:emoji1/:emoji2: Returns a specific emoji mix.
• GET /mix/random-url: Returns a random emoji mix url.

Tests

To run the tests use:

npm test

The project uses the following testing libraries:

• Mocha: A test framework that runs on Node.js and in the browser.
• Chai: A BDD / TDD assertion library for node and the browser.
• Sinon: Standalone test spies, stubs and mocks.

Contributing

Any help or feedback is appreciated. Feel free to open an issue or submit a pull request.

Acknowledgements

Special thanks to xsalazar for his research and depelopment with the emoji-kitchen project, it served as inspiration and a starting point for this project.

License

Licensed under the terms of the MIT license.