Giter VIP home page Giter VIP logo

planner's Introduction

Planner

React component library for the school year planning functionality of the Schul-Cloud built in Typescript.

It exports four different views and two setup functions that can be used to adjust the look and feel of the views.

The library was built as part of my master's thesis. Many information about the intial user research, the concept and implementation details are documented in my work.

Commands

  • yarn storybook - Starts Storybook - the UI component development environment on http://localhost:9001
  • yarn build - Builds library and generates typings to release a new version

Usage

  • Install and add the library to your package.json (It is not on npm so far)
  • Import views and setup functions
import {
  ClassConfigurationView, 
  CalendarView, 
  TopicTemplateView, 
  TopicInstanceView, 
  setupCustomStyles, 
  setupComponentMap
} from 'planner-core-lib';

ClassConfigurationView

Class Configuration View

CalendarView

Calendar View

TopicTemplateView

Topic Template View

TopicInstanceView

Topic Instance View

setupCustomStyles

This function allows to define custom properties for the whole library (e.g., primary color, font family).

setupComponentMap

This function allows to pass a component map with your custom components (e.g., buttons, selects, input) better suited for the look and feel of your application.

Storybook

The development of the component library is mainly done in Storybook. It offers an environment to look and play around with views and components. Moreover, the types and interfaces of components are documented and it is possible to change properties of individual components to see their behavoir.

planner's People

Contributors

ceev avatar

Watchers

Oliver Weidner avatar Dimitrij Pinneker avatar Jan Renz avatar James Cloos avatar MatthiasWiesner avatar Jeny Alejandra Mazo avatar Ioannis Koumarelas avatar Tobias W. avatar Phillip avatar Carl Gödecken avatar Hannes Schurig avatar Paul A. avatar  avatar Henriette Darge avatar Dominik Brüchner avatar Thomas Feldtkeller avatar Semih Zerdeli avatar  avatar  avatar  avatar  avatar ezzato avatar Adrian Jost avatar  avatar  avatar Ralf Nelles avatar

planner's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on Greenkeeper branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet.
We recommend using:

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please click the 'fix repo' button on account.greenkeeper.io.

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on Greenkeeper branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please click the 'fix repo' button on account.greenkeeper.io.

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.