This repository has been archived by the owner on Jan 25, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: adding back files from main branch
- Loading branch information
1 parent
7d1e9dd
commit 0a93502
Showing
3 changed files
with
199 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
# Contribution guidelines | ||
|
||
Thanks for showing interest to contribute to Manifest UI 💖, you rock! | ||
|
||
There are different ways you can contribute, all | ||
of which are valuable. Here's a few guidelines that should help you as you | ||
prepare your contribution. | ||
|
||
## Setup the Project | ||
|
||
The following steps will get you up and running to contribute to Manifest UI: | ||
|
||
1. Fork the repo (click the <kbd>Fork</kbd> button at the top right of | ||
[this page](https://github.com/project44/manifest-ui)) | ||
|
||
2. Clone your fork locally | ||
|
||
```sh | ||
git clone https://github.com/<your_github_username>/manifest-ui.git | ||
cd manifest-ui | ||
``` | ||
|
||
3. Setup all the dependencies and packages by running `yarn && yarn build`. This | ||
command will install dependencies | ||
|
||
> If you run into any issues during this step, kindly reach out to the Design System team [here](https://p-44.slack.com/archives/C02CL3RLKED). | ||
## Development | ||
|
||
_coming soon_ ✨ | ||
|
||
### Tooling | ||
|
||
- [Preconstruct](https://preconstruct.tools/) to dev and build code in the monorepo. | ||
- [Playroom](https://github.com/seek-oss/playroom/) for rapid UI prototyping. | ||
- [Storybook](https://storybook.js.org/) for building, documenting, and testing components. | ||
- [Changeset](https://github.com/atlassian/changesets) for changes | ||
documentation, changelog generation, and release management. | ||
|
||
### Commands | ||
|
||
**`yarn playroom`**: starts the Playroom prototyping environment. | ||
|
||
**`yarn storybook`**: starts Storybook for building and testing components. | ||
|
||
**`yarn build`**: run build for all component packages. | ||
|
||
**`yarn lint`**: runs all the safety checks (manypkg, eslint, prettier, and tsc). | ||
|
||
## Think you found a bug? | ||
|
||
Please conform to the issue template and provide a clear path to reproduction | ||
with a code example. The best way to show a bug is by sending a CodeSandbox | ||
link. | ||
|
||
You may wish to use our starters to help you get going: | ||
|
||
- JavaScript Starter: <https://codesandbox.io/s/manifest-ui-javascript-1i78l> | ||
- TypeScript Starter: <https://codesandbox.io/s/manifest-ui-typescript-u5hcs> | ||
|
||
## Proposing new or changed API? | ||
|
||
Please provide thoughtful comments and some sample API code. Proposals that | ||
don't line up with our roadmap or don't have a thoughtful explanation will be | ||
closed. | ||
|
||
## Making a Pull Request? | ||
|
||
Pull requests need only the :+1: of two or more collaborators to be merged; when | ||
the PR author is a collaborator, that counts as one. | ||
|
||
### Steps to PR | ||
|
||
1. Fork of the manifest-ui repository and clone your fork | ||
|
||
2. Create a new branch out of the `main` branch. We follow the convention | ||
`[type/scope]`. For example `fix/accordion-hook` or `docs/menu-typo`. `type` | ||
can be either `docs`, `fix`, `feat`, `build`, or any other conventional | ||
commit type. `scope` is just a short id that describes the scope of work. | ||
|
||
3. Make and commit your changes. | ||
As you develop, you can run `yarn build` and | ||
`yarn storybook` to make sure everything works as expected. | ||
|
||
4. Run `yarn changeset` to create a detailed description of your changes. This | ||
will be used to generate a changelog when we publish an update. | ||
[Learn more about Changeset](https://github.com/atlassian/changesets/tree/master/packages/cli). | ||
|
||
> If you made minor changes like CI config, prettier, etc, you can run | ||
> `yarn changeset add --empty` to generate an empty changeset file to document | ||
> your changes. | ||
## License | ||
|
||
By contributing your code to the manifest-ui GitHub repository, you agree to | ||
license your contribution under the MIT license. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2021 project44, Inc. | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
<p align="center"> | ||
<!-- image here --> | ||
</p> | ||
|
||
<h1 align="center">Manifest UI</h1> | ||
|
||
<p align="center">Design System themes and components for <a href="https://www.project44.com/">project44</a>.</p> | ||
|
||
<p align="center"> | ||
<a aria-label="Storybook" href="https://project44.github.io/manifest-ui/"> | ||
<img alt="" src="https://raw.githubusercontent.com/storybooks/brand/master/badge/badge-storybook.svg"> | ||
</a> | ||
<a aria-label="Playroom" href="https://project44.github.io/manifest-ui/playroom"> | ||
<img alt="" src="https://img.shields.io/badge/Playroom-live-blueviolet"> | ||
</p> | ||
|
||
<p align="center"> | ||
<a aria-label="npm package" href="https://www.npmjs.com/package/@manifest-ui/react"> | ||
<img alt="" src="https://img.shields.io/npm/v/@manifest-ui/react.svg"> | ||
</a> | ||
</a> | ||
<a aria-label="percy.io builds" href="https://percy.io/f2a7a5cd/manifest-ui"> | ||
<img alt="" src="https://percy.io/static/images/percy-badge.svg"> | ||
</a> | ||
<a aria-label="pages status" href="https://github.com/project44/manifest-ui/actions/workflows/pages.yml"> | ||
<img alt="" src="https://img.shields.io/github/workflow/status/project44/manifest-ui/Validate/main.svg?"> | ||
</a> | ||
</p> | ||
|
||
Themeable design system built using [Stitches] and [Radix] for project44. | ||
|
||
## Documentation | ||
|
||
Our documentation site lives at [p44design.systems]. You'll be able to find detailed documentation on getting started, all of the components, our theme, our principles, and more. | ||
|
||
## Installation | ||
|
||
Install `@manifest-ui/react` and necessary peer dependencies in your project with your package manager of choice: | ||
|
||
```sh | ||
# with npm | ||
npm install @manifest-ui/react | ||
|
||
# with yarn | ||
yarn add @manifest-ui/react | ||
``` | ||
|
||
## Usage | ||
|
||
To start using the theme and components, please follow these steps: | ||
|
||
Wrap your application with the `ManifestProvider` provided by **@manifest-ui/react**. | ||
|
||
```jsx | ||
import { ManifestProvider } from '@manifest-ui/react'; | ||
|
||
// Do this at the root of your application | ||
function App({ children }) { | ||
return <ManifestProvider>{children}</ManifestProvider>; | ||
} | ||
``` | ||
|
||
Now you can start using components like so: | ||
|
||
```jsx | ||
import { Button } from '@manifest-ui/react'; | ||
|
||
function Example() { | ||
return <Button>Track shipment</Button>; | ||
} | ||
``` | ||
|
||
## Contributing | ||
|
||
We love collaborating with folks inside and outside of project44 and welcome contributions! | ||
|
||
> 👉 See the [contributing docs] for more info on code style, testing, coverage, and troubleshooting | ||
[p44design.systems]: https://p44design.systems | ||
[stitches]: https://stitches.dev/ | ||
[radix]: https://www.radix-ui.com/ | ||
[contributing docs]: CONTRIBUTING.md |