Code Monkey home page Code Monkey logo

prenda-spark's Introduction

Prenda Spark logo

Prenda Spark

The official monorepo for libraries implementing the Spark Design System, intended for use in Prenda applications. Spark libraries include customized Material-UI components and Prenda illustrations and icons.

Contributors License NPM Latest Version NPM Downloads Conventional Commits Semantic Release Figma Nx Build State

Installation

Prenda Spark is available as an NPM package.

npm install @prenda/spark

Usage

here is a quick example to get you started.

import * as React from 'react';
import ReactDOM from 'react-dom';
import { SparkThemeProvider, Button } from '@prenda/spark';

function App() {
  return (
    <SparkThemeProvider>
      <Button>Hello World</Button>
    </SparkThemeProvider>
  );
}

ReactDOM.render(<App />, document.querySelector('#app'));

The SparkThemeProvider can be placed anywhere in the render tree, at least above a Spark component (the need for the theme provider may be removed in the future).

Documentation

There is no documentation site currently. We are working on getting a static storybook site up with self-documenting component stories.

Contributing

Read the contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Prenda Spark.

Changelog

If you have recently updated, please read the changelog for each library for details of what has changed.

License

This project is licensed under the terms of the MIT license.

About

This project was generated using Nx. This project was formerly generated using Create React App and TSdx.

Prenda Spark is designed using Figma application, but is not affiliated with Figma in any way.

prenda-spark's People

Contributors

williamkelley avatar pinindajin avatar haase1020 avatar smrbts avatar cardinalion avatar yuenkd avatar seigler avatar joshuasterling avatar jb-1980 avatar

Watchers

James Cloos 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.