Skip to content
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

Initial work for moving all react hooks to mono repo #20

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/**/dist/**/*.js
48 changes: 0 additions & 48 deletions .eslintrc

This file was deleted.

33 changes: 29 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,31 @@
dev
dist
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
node_modules
.pnp
.pnp.js

# testing
coverage

# misc
.DS_Store
.npmrc
*.log
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*
.pnpm-debug.log*

# local env files
.env.local
.env.development.local
.env.test.local
.env.production.local

# turbo
.turbo

# compiled
dist
121 changes: 50 additions & 71 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,90 +1,69 @@
<h1 align="center">@wappla/react-hooks</h1>
<div align="center">

[![GitHub release](https://img.shields.io/github/release/wappla/react-hooks.svg?style=flat-square)](https://github.com/wappla/react-hooks/releases/) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/react-hooks/blob/master/LICENSE) [![GitHub pull-requests](https://img.shields.io/github/issues-pr/wappla/react-hooks.svg?style=flat-square)](https://GitHub.com/wappla/react-hooks/pull/) [![GitHub issues](https://img.shields.io/github/issues/wappla/react-hooks.svg?style=flat-square)](https://GitHub.com/wappla/react-hooks/issues/)

<sub>
Built with ❤︎ by
<a href="#about-us">Wappla</a> and
<a href="https://github.com/wappla/use-form-state/graphs/contributors">
contributors
</a>
</sub>
</div>

<details>
<summary>Table of Contents</summary>

<!-- START doctoc -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
<!-- https://github.com/thlorenz/doctoc -->
<!-- doctoc README.md --github -->
<!-- END doctoc -->

</details>

## Motivation
One Paragraph of project description goes here

## Getting Started

To get started, add `@wappla/react-hooks` to your project:

Using npm:
```shell
npm install --save @wappla/react-hooks
```
# Dashdot React Hooks

Using yarn:
```shell
yarn add @wappla/react-hooks
```
This is an official Dashdot package.

Please note that `@wappla/react-hooks` requires `react@^16.12.0` as a peer dependency.
## What's inside?

## Running the tests
This turborepo uses [npm](https://www.npmjs.com/) as a package manager. It includes the following packages:

```shell
npm run test
```
### Packages

- `tsconfig`: `tsconfig.json`s used throughout the monorepo

Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).

### Utilities

This turborepo has some additional tools already setup for you:

- [TypeScript](https://www.typescriptlang.org/) for static type checking
- [ESLint](https://eslint.org/) for code linting
- [Prettier](https://prettier.io) for code formatting

### Build

## API
To build all apps and packages, run the following command:

### useAsyncEffect
### useDebounce
### useDebouncedCallback
### useLatest
### useOnClickOutside
### useWindowSize
Returns the size of the browser's window.
```
const {
innerWidth,
outerWidth,
innerHeight,
outerHeight,
} = useWindowSize()
cd react-hooks
npm run build
```

## Contributing
### Develop

Please read [CONTRIBUTING.md](https://github.com/wappla/react-hooks) for details on our code of conduct, and the process for submitting pull requests to us.
To develop all apps and packages, run the following command:

## Versioning
```
cd react-hooks
npm run dev
```

### Remote Caching

Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/wappla/react-hooks/tags).
By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands:

## Authors
```
cd react-hooks
npx turbo login
```

* **Sander Peeters** - *Initial work* - [Sander Peeters](https://github.com/SanderPeeters)
This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).

See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:

## About us
```
npx turbo link
```

[Wappla BVBA](https://www.wappla.com/)
We shape, build and grow ambitious digital products.
## Useful Links

## License
Learn more about the power of Turborepo:

This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/wappla/docs-general-base-templates/blob/master/LICENSE) file for details
- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)
3 changes: 0 additions & 3 deletions babel.config.js

This file was deleted.

9 changes: 0 additions & 9 deletions index.js

This file was deleted.

Loading