-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
1,212 additions
and
1,131 deletions.
There are no files selected for viewing
Binary file not shown.
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 |
---|---|---|
@@ -1,64 +1,60 @@ | ||
<p align="center"> | ||
<img src="./workspaces/site/src/assets/preshape.svg" alt="Preshape" /> | ||
</p> | ||
|
||
<h1 align="center"> | ||
Preshape | ||
</h1> | ||
![](./workspaces/site/src/assets/preshape.svg) | ||
|
||
<h3 align="center"> | ||
A minimal design system and library of React components to facilitate my own projects, you probably don't want to use it.<br/> | ||
<a>https://preshape.hogg.io</a> | ||
</h3> | ||
# Preshape | ||
|
||
<hr /> | ||
A design system and component library for my own personal projects. Take a look around. However, you probably shouldn't use this in your project as there's no guarantee of stability or support. | ||
|
||
### Getting Started | ||
## Using the library | ||
|
||
##### Install with your favourite package manager | ||
Install with your favourite package manager | ||
|
||
``` | ||
yarn add preshape | ||
``` | ||
|
||
### Documentation | ||
Add the CSS to your project, e.g. | ||
|
||
Description of the design system and component documentation can be found on the [Preshape site](https://preshape.hogg.io). | ||
```ts | ||
import 'preshape/dist/style.css'; | ||
``` | ||
|
||
### Technology | ||
then import and start using components. | ||
|
||
- [Typescript](https://www.typescriptlang.org/) | ||
- [Parcel](https://parceljs.org/) (bundler and dev servers) | ||
- [React](https://reactjs.org/) | ||
- [PostCSS](https://postcss.org/) (with postcss-preset-env for a little power) | ||
- [Firebase](https://firebase.google.com/) (hosting) | ||
```tsx | ||
import { Box } from 'preshape'; | ||
|
||
### Setup | ||
<Box>...</Box> | ||
``` | ||
## Documentation | ||
|
||
##### Prerequisites | ||
Description of the design system and component documentation can be found on the [Preshape site](https://preshape.hogg.io). | ||
|
||
## Development | ||
|
||
### Prerequisites | ||
|
||
• [Node](https://nodejs.org/en/) - Either use [nvm use](https://github.com/nvm-sh/nvm) or checkout the tested version inside the [.nvmrc](./nmvrc) file | ||
• [Yarn](https://yarnpkg.com) - `npm i yarn -g` | ||
|
||
##### Setup | ||
### Setup | ||
|
||
Clone the repository | ||
|
||
``` | ||
git clone [email protected]:HHogg/circles.git | ||
git clone [email protected]:HHogg/preshape.git | ||
``` | ||
|
||
Install the dependencies with your favourite package manager | ||
|
||
``` | ||
yarn install | ||
yarn | ||
``` | ||
|
||
##### Development | ||
|
||
Spin up the Parcel development server | ||
Spin up the dev server | ||
|
||
``` | ||
yarn start | ||
yarn dev | ||
``` | ||
|
||
### Contribution | ||
|
Oops, something went wrong.