@lexusdrumgold/utilities v2.0.3
Utility Functions
Helpful utility functions for Firebase, requesting data, handling server responses, and validating Joi schema.
Overview
Getting Started
Documentation
Development
Testing
Deployment
Built With
Getting Started
- Run
npm i --save @lexusdrumgold/utilitiesin your project directory. - Import the function(s) you wish to use.
Note: For Firebase utility functions you must have Firebase configured first.
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
Install Node and Git: Download Node here, and Git here
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/utilities.gitAfter cloning the repo, open the project. Run the following command:
npm installin the terminal. This will install the necessary dependencies for the project. A list of those dependencies can be found in
package.json.
Making Changes
- Add your environment variables to
env/.env.development. - Make your changes.
- When you're ready to test your changes, create a *.spec.js file under the
__tests__directory.
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.
Testing
When you're ready to test your changes, run npm run stage in your project
directory. This will run your tests, as well as all the tests in the __tests__
directory.
Note: Before 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."