Skip to content

Commit

Permalink
Merge pull request #10 from near/feat/near-org-updates
Browse files Browse the repository at this point in the history
Updates for Near Org
  • Loading branch information
calebjacob authored Aug 9, 2024
2 parents a603540 + f2d5648 commit 83ca810
Show file tree
Hide file tree
Showing 36 changed files with 879 additions and 81 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ npm-debug.log*
yarn-debug.log*
yarn-error.log*
.pnpm-debug.log*
stats.html

# local env files
.env.local
Expand Down
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@ Please refer to `README.md` files in `src/components` for examples and documenta

## Contributing

This project requires [pnpm](https://pnpm.io/installation) version `9.1.1`. The strict version requirement will help keep our lockfile consistent as more developers contribute. Make sure you have the correct version of `pnpm` installed:

```bash
pnpm -v # This should output 9.1.1
npm install -g [email protected] # Install the correct version if needed
```

Run these commands to begin local development and watch for changes:

```bash
Expand All @@ -56,6 +63,16 @@ Follow these steps to preview local changes to the UI library within any project

_NOTE: Due to this library having peer dependencies, `pnpm link` isn't compatible - that's why we have to rely on using `file:` instead._

## Viewing Package Statistics

After you've run `pnpm build` or `pnpm dev`, a `stats.html` file will be generated to show a visual breakdown of the size of the library based on source code and dependencies. You can open this in your browser by running:

```bash
open ./stats.html
```

This can be helpful to catch or debug a dependency that might have bloated the package size.

## Publishing a Release

- Merge all desired changes into `main` via pull requests.
Expand Down
7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@near-pagoda/ui",
"version": "0.2.7",
"version": "0.3.0",
"description": "A React component library that implements the official NEAR design system.",
"license": "MIT",
"repository": {
Expand Down Expand Up @@ -83,8 +83,8 @@
"@testing-library/react": "^16.0.0",
"@types/lodash-es": "^4.17.12",
"@types/node": "^20",
"@types/react": "^18.2.34",
"@types/react-dom": "^18.0.6",
"@types/react": "^18",
"@types/react-dom": "^18",
"eslint": "^8",
"eslint-config-next": "^14.2.5",
"eslint-config-prettier": "^9",
Expand All @@ -100,6 +100,7 @@
"rollup-plugin-delete": "^2.0.0",
"rollup-plugin-peer-deps-external": "^2.2.4",
"rollup-plugin-postcss": "^4.0.2",
"rollup-plugin-visualizer": "^5.12.0",
"sass": "^1.77.8",
"tslib": "^2.6.2",
"typescript": "^5",
Expand Down
111 changes: 109 additions & 2 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions rollup.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import copy from 'rollup-plugin-copy';
import del from 'rollup-plugin-delete';
import peerDepsExternal from 'rollup-plugin-peer-deps-external';
import postcss from 'rollup-plugin-postcss';
import { visualizer } from 'rollup-plugin-visualizer';

/** @type {import('rollup').RollupOptions} */
const options = {
Expand Down Expand Up @@ -49,6 +50,7 @@ const options = {
],
}),
del({ targets: 'dist/styles.css' }),
visualizer(),
],
};

Expand Down
Loading

0 comments on commit 83ca810

Please sign in to comment.