fairfield-programming / ducks

🦆 The repository for dealing with all the ducks created and managed by the Fairfield Programming Association.

Download

Since the Fairfield Programming Association's duck generator is built on top of node.js and npm, you need to have both of those installed as prerequisites. After that, to download the project, you have to run the below command. From there, you can include it in your node.js code by using the import or require system.

npm install duckgen

Features

We didn't want to use people's faces for the profile pictures. This was for three reasons: we didn't want to pay for hosting the image files, we were scared of what people would upload, and since our main audience is minors, we didn't want their faces to be publicly available. To solve these problems, we decided to use rubber duck avatars instead of photos. Users are able to customize their ducks by adding glasses, hats, items, etc (and they can even set their own colors).

How to Use

After running npm install duckgen, you can use it in your code using one of the two below systems. The API is very simple and you can check out the code to the project for the API reference.

ES6

import duckgen from "duckgen";

Node.js Require

const duckgen = require("duckgen");

Contributing

If you simply star the repo, this helps us out tremendiously. Past that, if you share this repo with your friends, that helps a lot too. If you are feeling super generous, then you can find some issues that you have with the project and try to help us with them.

To start helping, you can click some of the above labels to jump to the pages with issues. Or, you can submit an issue by clicking the last button.