Skip to content

Commit

Permalink
Update README with development information
Browse files Browse the repository at this point in the history
  • Loading branch information
shaes-farm committed Aug 19, 2023
1 parent 0a439c1 commit 95d63c0
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ pnpm add @shaes-farm/mui-mas

In Spanish "mui mas" means "much more", and that's what we provide with this component library; much more than the basic set of Material UI components.

We've developed an opinionated set of React components based on [MUI templates](https://mui.com/material-ui/getting-started/templates/) that allow us to quickly construct functionality needed by our applications, with built-in support for MUI, Supabase, and Next.js. With <code>mui-mas</code> we can scaffold an app in minutes, instead of hours, and get functional applications more quickly, customized to our workflows.
We've developed an opinionated set of React components based on [MUI templates](https://mui.com/material-ui/getting-started/templates/) that allow us to quickly construct functionality needed by our React applications, with built-in support for MUI, Next, and Supabase. With <code>mui-mas</code> we can scaffold an app in minutes, instead of hours, quickly getting functional applications up and customized to our workflows.

## Early Release

Expand All @@ -42,3 +42,31 @@ We are releasing <code>mui mas</code> as an open-source component library becaus
## Help Us Improve

You can help us make this library better by [creating a pull request](https://github.com/shaes-farm/mui-mas/pulls) with suggestions. We gladly accept bug fixes, improvements, or just show us how you would make the library better able to support a wider choice of use cases. Any ideas, suggestions, and critical reviews are all welcomed as we continue to improve this package for our own needs, [open an issue to send us your feedback](https://github.com/shaes-farm/mui-mas/issues).

## Development Environment Setup

We use the [Node Version Manager](https://github.com/nvm-sh/nvm) to manage our Javascript development environments. See the [documentation](https://github.com/nvm-sh/nvm#installing-and-updating) for more information on installing `nvm` and getting set up.

After installing `nvm`, and cloning the `mui-mas` repository, the component library and the example application are built. To run the example in a development environment, perform the following commands:

```sh
cd mui-mas
nvm use
npm i
npm run verify
npm link
cd example
npm i
npm link @shaes-farm/mui-mas
npm run dev
```

To automatically see the results of developing changes to `mui-mas` components in the example application, open another terminal window, and run:

```sh
cd mui-mas
nvm use
npm run dev
```

This will start the Typescript compiler in watch mode, automatically building changes as they occur.

0 comments on commit 95d63c0

Please sign in to comment.