PrettyCoffee / startpage

A React library which provides tools that help creating browser startpages in react.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

@startpage license-badge

@startpage is a library that provides tools to facilitate the process of creating a browser start page.

Take a look at the documentation for more details.

If you want to see how it works in a real world scenario, you can check out the example project.

Getting Started

Installation

npm i @startpage/<package>

Creating a new project

If you want to create a new project, you can use one of the startpage create-react-app templates:

// base template
npx create-react-app <some-app-name> --template startpage

// with emotion js
npx create-react-app <some-app-name> --template startpage-emotion

Packages

name description
bookmarks Bookmark management for your startpage docs
local-storage Local storage management for your startpage docs
preset Use presets for your startpage. docs
search Provides a function to search the web docs
theming Provide a design system for your startpage. docs

Core concepts

Before you start working with this library, you should be aware of the following core concepts it uses:

Note

I recommend using Typescript and Emotion with this library since its designed for this usecase. That being said, everything should work just fine without them.

About

A React library which provides tools that help creating browser startpages in react.

License:MIT License


Languages

Language:TypeScript 88.0%Language:HTML 6.8%Language:JavaScript 3.7%Language:CSS 1.5%Language:Shell 0.1%