Giter Club home page Giter Club logo

andculturecode.javascript.core's Introduction

AndcultureCode.JavaScript.Core

build status codecov All Contributors

Common patterns, functions, etc... used when building javascript applications

Getting started

This package is installed via npm or yarn

# npm
npm install --save-dev andculturecode-javascript-core

# yarn
yarn add andculturecode-javascript-core --dev

From there you can import the variety of modules.

import { CollectionUtils, CoreUtils } from "andculturecode-javascript-core";

You can also reference the global distribution package within a website which gives you access to the AndcultureCode namespace. See the example below

<script src="https://unpkg.com/browse/andculturecode-javascript-core@[version-number]/dist/global/index.js"></script>

<script>
    var myAuthObject = AndcultureCode.RouteUtils.queryStringToObject(
        "#token=bada55cafe"
    );
</script>

Peer dependencies

This package wraps several external packages for our own configuration and ease of use, such as axios, i18next, lodash, etc. If you are using the standard distribution of this package, these will need to be installed alongside this package, even if you do not plan on leveraging features that rely on them.

If using the global distribution, you will likely want to reference these in your website prior to referencing this package. See test-global-distribution.html for the full list of dependencies. Unlike the standard distribution, peer dependencies are only required if your code will be executing code paths that rely on those packages.

Internationalization

This package offers a variety of functions for localizing an application, wrapping i18next and i18next-browser-languagedetector. A complete setup guide can be found in the wiki here.

If developing in VS Code, the kazoo extension can be used to quickly insert typed keys and placeholder translations from Google Translate. (source | install)

Documentation

Full API documentation

Contributing

Information on contributing to this repo is in the Contributing Guide

Contributors โœจ

Thanks goes to these wonderful people (emoji key):


Winton DeShong

๐Ÿ’ป ๐Ÿ“– ๐Ÿšง โš ๏ธ ๐Ÿ‘€

Brandon Scott

๐Ÿ’ป ๐Ÿšง โš ๏ธ ๐Ÿ‘€

Said B Shah

๐Ÿ’ป โš ๏ธ ๐Ÿšง

Mat Jones

๐Ÿ’ป โš ๏ธ

Dylan Justice

๐Ÿ’ป โš ๏ธ ๐Ÿ‘€

Kevin Busch

๐Ÿš‡ ๐Ÿšง

Stefanie Leitch

๐Ÿ‘€

Nhinh Dao

โš ๏ธ ๐Ÿšง

Michael Tyson

๐Ÿ’ป โš ๏ธ ๐Ÿ‘€

Joshua Hughes

๐Ÿ‘€

Jeb

๐Ÿ‘€

This project follows the all-contributors specification. Contributions of any kind welcome!

andculturecode.javascript.core's People

Contributors

allcontributors[bot] avatar brandongregoryscott avatar dependabot[bot] avatar dtnhinh avatar dylanjustice avatar heykos avatar kevinbusch avatar mrjones2014 avatar myty avatar nhinhdao avatar wintondeshong avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.