giftly
v1.0.1
Published
A free gift idea generator app for any occasion
Downloads
8
Maintainers
Readme
🌐 Giftly Works in Node AND browser environments
Yes, this module works in both Node and browser environments, including compatibility with Webpack and Browserify!
🦄 Features
- Getting proxy lists
🔑 Getting an API key
You can use so much of giftly
for free, but if you want to do some advanced stuff, you'll need an API key. You can get one by signing up for a Giftly account.
📦 Install Giftly
Option 1: Install via npm
Install with npm if you plan to use giftly
in a Node project or in the browser.
npm install giftly
If you plan to use giftly
in a browser environment, you will probably need to use Webpack, Browserify, or a similar service to compile it.
const giftly = new (require('giftly'))({
// Not required, but having one removes limits (get your key at https://giftly.app).
apiKey: 'api_test_key'
});
Option 2: Install via CDN
Install with CDN if you plan to use Giftly only in a browser environment.
<script src="https://cdn.jsdelivr.net/npm/giftly@latest/dist/index.min.js"></script>
<script type="text/javascript">
var giftly = new Giftly({
// Not required, but having one removes limits (get your key at https://giftly.app).
apiKey: 'api_test_Key'
});
</script>
Option 3: Use without installation
You can use giftly
in a variety of ways that require no installation, such as curl
in terminal/shell. See the Use without installation section below.
⚡️ Using Giftly
After you have followed the install step, you can start using giftly
to get gift ideas for any occasion!
For a more in-depth documentation of this library and the Giftly service, please visit the official Giftly website.
🔧 Use without installation
Use Giftly with curl
# Standard
curl -X POST https://api.giftly.app
📝 What Can Giftly do?
Giftly is a free gift idea generator app for any occasion!
🗨️ Final Words
If you are still having difficulty, we would love for you to post a question to the Giftly issues page. It is much easier to answer questions that include your code and relevant files! So if you can provide them, we'd be extremely grateful (and more likely to help you find the answer!)
📚 Projects Using this Library
- coming soon!
Ask us to have your project listed! :)