-
Notifications
You must be signed in to change notification settings - Fork 2.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Tweak readme's. Add simpler npm scripts to avoid npm install -g #81
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,28 +6,28 @@ This repository does not contain compiled assets so please install relevant pack | |
|
||
## Packages | ||
|
||
This repository contains multiple projects in the `packages/` directory that are ultimately distributed as separate packages on NPM: | ||
This repository contains multiple projects in the `packages/` directory that are distributed as separate packages on NPM: | ||
|
||
[![npm](https://img.shields.io/npm/v/@blueprintjs/core.svg?label=@blueprintjs/core)](https://www.npmjs.com/package/@blueprintjs/core) – Core styles & components for the UI kit. | ||
|
||
[![npm](https://img.shields.io/npm/v/@blueprintjs/datetime.svg?label=@blueprintjs/datetime)](https://www.npmjs.com/package/@blueprintjs/datetime) – Date & time UI components. | ||
[![npm](https://img.shields.io/npm/v/@blueprintjs/datetime.svg?label=@blueprintjs/datetime)](https://www.npmjs.com/package/@blueprintjs/datetime) – Date & time UI component. | ||
|
||
[![npm](https://img.shields.io/npm/v/@blueprintjs/table.svg?label=@blueprintjs/table)](https://www.npmjs.com/package/@blueprintjs/table) – Scalable interactive table UI components. | ||
[![npm](https://img.shields.io/npm/v/@blueprintjs/table.svg?label=@blueprintjs/table)](https://www.npmjs.com/package/@blueprintjs/table) – Scalable interactive table UI component. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. again, package defines several components. i struggle with how to explain the table library, because there is a component called There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ✅ legit |
||
|
||
The other packages (`docs` and `landing`) are not published to NPM as they are used to build the documentation site. | ||
|
||
## Development | ||
|
||
We use [Lerna](https://github.com/lerna/lerna) to manage inter-package dependencies in this monorepo. | ||
We use [Lerna](https://lernajs.io/) to manage inter-package dependencies in this monorepo. | ||
Builds are orchestrated via [Gulp](http://gulpjs.com/) tasks. | ||
|
||
__Prerequisite__: Node.js v6 or v7 | ||
|
||
1. `git clone` this repository (or fork if you lack permissions) | ||
1. `npm install` to install build dependencies | ||
1. `$(npm bin)/lerna bootstrap` to configure each package | ||
1. `gulp` to compile and start the server | ||
1. Visit [localhost:9000/packages/docs/dist/](http://localhost:9000/packages/docs/dist/) | ||
1. `npm run bootstrap` to install and link each package using [lerna](https://lernajs.io/) | ||
1. `npm run gulp` to compile and start the server and watcher | ||
1. Open your browser to [localhost:9000/packages/docs/dist/](http://localhost:9000/packages/docs/dist/) | ||
|
||
## Contributing | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,7 +4,7 @@ Blueprint is a React UI toolkit for the Web. | |
|
||
This package contains the core set of UI components as CSS and React code. | ||
|
||
## Usage | ||
## Installations | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. singular? |
||
|
||
``` | ||
npm install --save @blueprintjs/core | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# [Blueprint](http://blueprintjs.com/) Date & Time Components | ||
# [Blueprint](http://blueprintjs.com/) Date & Time Component | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. plural |
||
|
||
Blueprint is a React UI toolkit for the Web. | ||
|
||
|
@@ -11,10 +11,10 @@ Two third-party libraries are used in this package to ease the burden of time ma | |
- [react-day-picker](http://react-day-picker.js.org/) is a solid React calendaring library. | ||
We use it internally for the calendar and expose some parts of its API (particularly modifiers). | ||
|
||
## Usage | ||
## Installation | ||
|
||
``` | ||
npm install --save @blueprintjs/datetime | ||
npm install --save @blueprintjs/core @blueprintjs/datetime | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
``` | ||
|
||
### [Full Documentation](http://blueprintjs.com/docs) | [Source Code](https://github.com/palantir/blueprint) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# [Blueprint Documentation](http://blueprintjs.com/docs) | ||
|
||
This project generates and aggregates the documentation from the packages | ||
in this repo. | ||
|
||
## Quick start | ||
|
||
From the root of the repo: | ||
|
||
1. Run `npm run bootstrap` | ||
1. Run `npm run gulp` | ||
1. Open your browser to http://localhost:9000 |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# [Blueprint](http://blueprintjs.com/) Table Components | ||
# [Blueprint](http://blueprintjs.com/) Table Component | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. plural? not sure about this one There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ✅ spoke offline, this is legit |
||
|
||
Blueprint is a React UI toolkit for the Web. | ||
|
||
|
@@ -15,10 +15,10 @@ or spreadsheet. | |
- Right-click to copy cell region contents | ||
- Inline editable column headers & cells | ||
|
||
## Usage | ||
## Installation | ||
|
||
``` | ||
npm install --save @blueprintjs/table | ||
npm install --save @blueprintjs/core @blueprintjs/table | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
unless we want to encourage this behavior, for version sanity? |
||
``` | ||
|
||
### [Table Documentation](http://blueprintjs.com/docs/#components.table-js) | [Full Documentation](http://blueprintjs.com/docs) | [Source Code](https://github.com/palantir/blueprint) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👎 there are many components in this package