Skip to content

Latest commit

 

History

History
131 lines (85 loc) · 3.72 KB

README.md

File metadata and controls

131 lines (85 loc) · 3.72 KB
Raw

Fogg - Now using Gatsby v5

Fogg is a component library that stems from the need to quickly spin up new mapping applications with search capabilities. While the library contains generic components needed within a typical map-based dashboard, the Lens component is what serves as the flagship component to wrap a map.

This library is packaged as a Gatsby theme that can be easily imported to a project.

What's inside?

  • Gatsby for templating and static site generation
  • Gatsby relies on React as the UI framework
  • Gatsby Themes are utilized to provide a reusable starting point for mapping UIs
  • Storybook is used as the presentational UI and documentation

Getting Started

Installing Fogg

Add Fogg as a dependency to your project

# With npm
npm install fogg

Note: if install fails, try using the --legacy-peer-deps flag with the install command.

Using the Library

Components

Importing the Lens component:

import { Lens } from 'fogg/ui';

const MyComponent = () => {
  return (
    <Lens {...lensSettings} />
  )
}

Hooks

Importing the hook that provides an API to Lens:

import { useLens } from 'fogg/hooks';
const { geoSearch = {}, map = {} } = useLens();
const { search } = geoSearch;

search(searchSettings);

Developing

Prerequisites

  • Node version specified in .nvmrc
  • NVM is highly recommended

Installation

Run the following commands in your terminal to install all dependencies:

nvm use
npm install

Development

Run the following command to start up your development server:

npm start

Testing

Run the following command to run the test suite:

npm test

Run the following command to run tests while updating the snapshot

npm run test-clean

Contributions

We are happy to take contributions! It is best to get in touch with the maintainers about larger features or design changes before starting the work, as it will make the process of accepting changes smoother.

Contributor License Agreement (CLA)

Everyone who contributes code to Fogg will be asked to sign a CLA, which is based off of the Apache CLA.

  • Download a copy of one of the following from the docs/cla directory in this repository:

    • Individual Contributor (You're using your time): 2024_10_10-Fogg-Open-Source-Contributor-Agreement-Individual.pdf
    • Corporate Contributor (You're using company time): 2024_10_10-Fogg-Open-Source-Contributor-Agreement-Corporate.pdf

  • Sign the CLA -- either physically on a printout or digitally using appropriate PDF software.

  • Send the signed CLAs to Element 84 via one of the following methods:

    • Emailing the document to [email protected]
    • Mailing a hardcopy to: Element 84, 210 N. Lee Street Suite 203 Alexandria, VA 22314, USA.

Need an older version?

We aren't always on top of publishing versions of fogg to NPM, but before cutting major updates (e.g. Gatsby 2 > 4) we at least try to keep a branch available with the legacy versions for anyone who isn't ugprading Gatsby yet.

TODO

  • Publish current version to NPM
  • Publish gatsby-v2 & gatsby-v4 to NPM
  • Add Snyk scan to Github actions
  • Complete stories for each major component
  • Clean out unused components
  • Add basic tests for each component
  • Add tests for lib
  • Add tests for hooks
  • Examples