@flexdevelopment/utilities NPM

Flex Development Utilities

Overview

What is Flex Development Utilities?
Getting Started
Development
Testing
Built With

What is Flex Development Utilities?

Flex Development Utilities is a set of JavaScript utility functions. The nature of the functions ranges from general utility functions to Firebase and response utilities.

Getting Started

Attention: This section is under construction.

Installation

Install the utilities package by running the command npm i --save @flexdevelopment/utilities in your project directory.

Usage

Attention: This section is under construction.

Development

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Installing

Follow the steps below to get your development enviroment set up.

Clone the repo. Open the terminal and and run the following:

git clone https://github.com/lexusdrumgold/flexdevelopment-utilities.git

Run npm install in your terminal. This will install your project dependencies.

Making Changes

In your terminal, run the command npm run dev.
Under src, make your changes.

References

Attention: This section is under construction.

Documentation

Following JSDoc standards, be sure to document any functions, classes, and other code you write. It will be reviewed by a reviewer during your code review, and your pull request will be denied if any code is improperly documeted.

For an overview of our JavaScript style guide, go to https://standardjs.com.

Testing

When you're ready to test your changes, you have two options: 1. Run npm test in your project directory. This run your tests, as well as all the tests in the tests in the tests directory. 2. Run jest tests/<PATH_TO_YOUR_TEST>. This will run your test file alone.

Note: Before creating a new branch and creating a pull request for your changes, your build must pass all the tests. If you need help, please create a test file and leave a comment in the test body, making note of any issues in their respective files. Make sure to label your pull request "help wanted."

If you're ready to have your changes reviewed, make sure your code is well documented, and create a branch for your changes. Make sure to name the branch appropriately, prefixing it with feature-, issue-, hotfix-, or release-. To do this, run the following in your terminal:
1. git checkout -b <BRANCH_NAME> 2. git commit -am "<DESCRIPTIVE_COMMIT_MESSAGE>" 3. git push 4. git checkout master

If you need to make additional changes, checkout your branch again, and then commit and push your changes.