Have ideas to improve npm?Join in the discussion! »

    flagpack-core
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.2 • Public • Published

    Flagpack

    Flagpack contains 260+ flag icons to easily use within your code project. Flagpack is an open source project and available for JavaScript frameworks/libraries Angular, Vue and React.

    Flagpack. 260+ easily implementable flag icons to use in your design or code project. Open Source. Available for Sketch, Figma, Angular, Vue, and React. www.flagpack.xyz. Made with love by Yummygum. Graphic showing a list with the flags of Argentina, Croatia, Estonia, Kenia, Netherlands, and Scotland.

    View documentation on flagpack.xyz

    flagpack-core

    The core has been created to provide and share any logic and assets to the desired components. For example, it can also be used to map over the `countryCodeList.json` to display all flags.

    Installation

    Normally if you'll use any component the core will be automatically installed as peer dependency. If you want to test the core, you'll need to install one of the components and install the core as local module.

    Example

    # install local module to one of the components
    npm install ../path/to/flagpack-core

    Build Dist

    You'll need an .env file with a SPREADSHEET_KEY and API_KEY to be able to build the generateCodeList.js script to make the request to the GoogleAPI to fetch the flags data.

    If you just want to make changes to the generateFlags.js, the .env is not needed, just use the current countryCodeList.json.

    # install dependencies
    npm install
    
    # build for prod
    npm run build
    
    # build with watcher for dev
    npm run dev

    Releasing

    To release a new version you'll need to make sure all changes commits are done and pushed. After that you'll need to decide which release type you want to use. The release types are; patch (0.0.1), minor (0.1.0), or major (1.0.0).

    npm version <release_type>
    

    This will update the version number in the package.json, and will add a git tag automatically. Next you'll need to push the git tag to the remote.

    git push --tags origin master
    

    After that you'll need to publish to npm.

    npm publish
    

    When you're confident with the release, make sure the version tag is also released at GitHub.

    Support

    Frequently Asked Questions

    Documentation

    Releases

    You can find a changelog of Flagpack's releases on the Releases page on GitHub.

    Contribute

    If you're interested in contributing to this project, great! Please see the contributing document.

    License

    Flagpack is an open source project published under a MIT license.

    Install

    npm i flagpack-core

    DownloadsWeekly Downloads

    424

    Version

    1.1.2

    License

    MIT

    Unpacked Size

    9.61 MB

    Total Files

    1817

    Last publish

    Collaborators

    • avatar