Skip to content

Commit 4f29cc6

Browse files
christianmatchristianmat
committed
fix(initial push): initial push
0 parents  commit 4f29cc6

25 files changed

+37578
-0
lines changed

‎.babelrc‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"presets": [
3+
"@babel/preset-env",
4+
"@babel/preset-react"
5+
],
6+
"plugins": [
7+
"@babel/plugin-transform-runtime"
8+
]
9+
}

‎.eslintrc.js‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
module.exports = {
2+
'parser': '@typescript-eslint/parser',
3+
'extends': [
4+
'airbnb',
5+
'plugin:prettier/recommended',
6+
'plugin:react/recommended',
7+
'plugin:react-hooks/recommended',
8+
'plugin:jsx-a11y/recommended',
9+
'plugin:react-native/all',
10+
],
11+
'plugins': [
12+
'prettier',
13+
'react'
14+
],
15+
'parserOptions': {
16+
'ecmaFeatures': {
17+
'jsx': true
18+
}
19+
},
20+
'rules': {
21+
'react/require-default-props': 'off',
22+
'import/prefer-default-export': 'off',
23+
'react-hooks/exhaustive-deps': 'warn',
24+
'react-hooks/rules-of-hooks': 'error',
25+
'react/jsx-filename-extension': [1, { 'extensions': ['.ts', '.tsx'] }],
26+
'react/jsx-indent-props': [2, 4],
27+
'react/jsx-indent': [2, 4],
28+
'react/jsx-one-expression-per-line': [0],
29+
'react/prefer-stateless-function': [1],
30+
'react/static-property-placement': [1, 'property assignment'],
31+
'prettier/prettier': [
32+
'error',
33+
{
34+
singleQuote: true,
35+
trailingComma: 'es5',
36+
},
37+
],
38+
}
39+
};

‎.github/workflows/release.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Release
2+
on:
3+
workflow_run:
4+
workflows: ['Tests']
5+
branches: [main]
6+
types:
7+
- completed
8+
jobs:
9+
release:
10+
name: Release
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v2
15+
with:
16+
fetch-depth: 0
17+
- name: Setup Node.js
18+
uses: actions/setup-node@v2
19+
with:
20+
node-version: 'lts/*'
21+
- name: Install dependencies
22+
run: npm ci
23+
- name: Build
24+
run: npm run build
25+
- name: Release
26+
env:
27+
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
28+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
29+
run: npx semantic-release

‎.github/workflows/tests.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Tests
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
build:
11+
12+
runs-on: ubuntu-latest
13+
14+
strategy:
15+
matrix:
16+
node-version: [18.x, 19.x]
17+
18+
steps:
19+
- uses: actions/checkout@v3
20+
- name: Use Node.js ${{ matrix.node-version }}
21+
uses: actions/setup-node@v3
22+
with:
23+
node-version: ${{ matrix.node-version }}
24+
- run: npm install
25+
- run: npm test

‎.gitignore‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
9+
# Diagnostic reports (https://nodejs.org/api/report.html)
10+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
11+
12+
# Runtime data
13+
pids
14+
*.pid
15+
*.seed
16+
*.pid.lock
17+
18+
# Directory for instrumented libs generated by jscoverage/JSCover
19+
lib-cov
20+
21+
# Coverage directory used by tools like istanbul
22+
coverage
23+
*.lcov
24+
25+
# nyc test coverage
26+
.nyc_output
27+
28+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
29+
.grunt
30+
31+
# Bower dependency directory (https://bower.io/)
32+
bower_components
33+
34+
# node-waf configuration
35+
.lock-wscript
36+
37+
# Compiled binary addons (https://nodejs.org/api/addons.html)
38+
build/Release
39+
40+
# Dependency directories
41+
node_modules/
42+
jspm_packages/
43+
44+
# TypeScript v1 declaration files
45+
typings/
46+
47+
# TypeScript cache
48+
*.tsbuildinfo
49+
50+
# Optional npm cache directory
51+
.npm
52+
53+
# Optional eslint cache
54+
.eslintcache
55+
56+
# Microbundle cache
57+
.rpt2_cache/
58+
.rts2_cache_cjs/
59+
.rts2_cache_es/
60+
.rts2_cache_umd/
61+
62+
# Optional REPL history
63+
.node_repl_history
64+
65+
# Output of 'npm pack'
66+
*.tgz
67+
68+
# Yarn Integrity file
69+
.yarn-integrity
70+
71+
# dotenv environment variables file
72+
.env
73+
.env.test
74+
75+
# parcel-bundler cache (https://parceljs.org/)
76+
.cache
77+
78+
# Next.js build output
79+
.next
80+
81+
# Nuxt.js build / generate output
82+
.nuxt
83+
dist
84+
85+
# Gatsby files
86+
.cache/
87+
# Comment in the public line in if your project uses Gatsby and *not* Next.js
88+
# https://nextjs.org/blog/next-9-1#public-directory-support
89+
# public
90+
91+
# vuepress build output
92+
.vuepress/dist
93+
94+
# Serverless directories
95+
.serverless/
96+
97+
# FuseBox cache
98+
.fusebox/
99+
100+
# DynamoDB Local files
101+
.dynamodb/
102+
103+
# TernJS port file
104+
.tern-port
105+
106+
.dccache
107+
.DS_Store
108+
lib
109+
*.tgz
110+
.idea
111+
.watchmanconfig
112+
ios/Pods

‎.npmignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
tests
2+
examples
3+
static
4+
ios

‎.prettierrc‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"printWidth": 100,
3+
"semi": false,
4+
"singleQuote": true,
5+
"tabWidth": 2,
6+
"trailingComma": "es5"
7+
}

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 Frigade
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
[![npm license](https://img.shields.io/npm/l/@frigade/react-onboarding-components)](https://www.npmjs.com/package/@frigade/react-onboarding-components)
2+
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
3+
4+
<H3 align="center"><strong>React Onboard</strong></H3>
5+
<div align="center">Build better product onboarding in your app.<br />High-quality components for checklists, tours, and more.</div>
6+
<br />
7+
<div align="center">
8+
<a href="https://frigade.com">Website</a>
9+
<span> · </span>
10+
<a href="https://github.com/FrigadeHQ">GitHub</a>
11+
<span> · </span>
12+
<a href="https://discord.gg/3fujYupY">Discord</a>
13+
</div>
14+
15+
## Introduction
16+
17+
A library of high-quality components for creating beautiful onboarding and product education in your React apps.
18+
The library helps developers build better onboarding experiences faster so they can focus on what matters most: building great products.
19+
20+
## Why
21+
22+
Product onboarding is one of the most important experiences in your app. It's usually the first thing your users see, and it's the first impression they have of your product.
23+
But it's difficult to get right and slow to build. We believe there needs to be a better way to build and iterate on high-quality onboarding experiences.
24+
25+
## Features
26+
27+
- 🎨 Fully customizable components and config
28+
- 🔧 Load images and content from your backend
29+
- ✨ Beautiful default UI
30+
31+
## Install
32+
33+
Install the package from your command line.
34+
35+
#### With yarn
36+
37+
```bash
38+
yarn add @frigade/react-onboarding-components
39+
```
40+
41+
#### With npm
42+
43+
```bash
44+
npm install @frigade/react-onboarding-components
45+
```
46+
47+
## Supercharge your onboarding flows
48+
While the above examples contain hard-coded strings and images for illustrative purposes, we highly recommend loading your strings and presentation
49+
layer logic from your API rather than as plain strings in your app.
50+
51+
We built [Frigade](https://frigade.com/) to work seamlessly with `react-onboarding-components` and make it easier for developers to build and scale onboarding.
52+
With Frigade, you can update onboarding flow without releasing to the app store, integrate 3rd party analytics (Segment, Mixpanel, etc.) to power user targeting, and integrate our API/webhooks to make user data input easy.
53+
54+
## Get in touch
55+
Questions? Suggestions? Feel free to [open an issue](https://github.com/FrigadeHQ/react-onboarding-components/issues), [submit a PR](https://github.com/FrigadeHQ/react-onboarding-components/pulls), or [contact us](https://frigade.com).
56+
57+
## License
58+
59+
MIT License

‎__mocks__/styleMock.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = {};

0 commit comments

Comments
 (0)