Skip to content

Commit

Permalink
docs, packages: new library and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
damianricobelli committed Aug 15, 2024
1 parent 2462308 commit c91c217
Show file tree
Hide file tree
Showing 165 changed files with 10,961 additions and 3,363 deletions.
8 changes: 8 additions & 0 deletions .changeset/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Changesets

Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
with multi-package repos, or single-package repos to help you version and publish your code. You can
find the full documentation for it [in our repository](https://github.com/changesets/changesets)

We have a quick list of common questions to get you started engaging with this project in
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
11 changes: 11 additions & 0 deletions .changeset/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
"changelog": "@changesets/cli/changelog",
"commit": false,
"fixed": [],
"linked": [],
"access": "restricted",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": []
}
49 changes: 49 additions & 0 deletions .github/workflows/changelog-release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Changelog and Release

on:
push:
tags:
- 'v*.*.*'
paths:
- 'packages/react/**'

jobs:
changelog:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: '18'

- name: Cache pnpm modules
uses: actions/cache@v4
with:
path: |
**/node_modules
**/.pnpm-store
key: pnpm-${{ hashFiles('**/pnpm-lock.yaml') }}
restore-keys: |
pnpm-
- name: Install pnpm
run: npm install -g pnpm

- name: Install dependencies
run: pnpm install

- name: Generate changelog and version
run: pnpm version-packages
env:
GH_ACTION_TOKEN: ${{ secrets.GH_ACTION_TOKEN }}

- name: Create GitHub Release
uses: softprops/action-gh-release@v2
with:
token: ${{ secrets.GH_ACTION_TOKEN }}
files: |
CHANGELOG.md
46 changes: 46 additions & 0 deletions .github/workflows/npm-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Publish to npm

on:
push:
tags:
- 'v*.*.*'
paths:
- 'packages/react/**'

jobs:
publish:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: '18'

- name: Cache pnpm modules
uses: actions/cache@v4
with:
path: |
**/node_modules
**/.pnpm-store
key: pnpm-${{ hashFiles('**/pnpm-lock.yaml') }}
restore-keys: |
pnpm-
- name: Install pnpm
run: npm install -g pnpm

- name: Install dependencies
run: pnpm install --frozen-lockfile

- name: Build the Package
run: pnpm build
working-directory: packages/react

- name: Publish to npm
env:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
run: pnpm release
51 changes: 28 additions & 23 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,36 +1,41 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
# Dependencies
node_modules
.pnp
.pnp.js
.yarn/install-state.gz

# testing
/coverage
# Local env files
.env
.env.local
.env.development.local
.env.test.local
.env.production.local

# next.js
/.next/
/out/
# Testing
coverage

# production
/build
# Turbo
.turbo

# Vercel
.vercel

# Build Outputs
.next/
out/
build
dist

# misc
.DS_Store
*.pem

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

# local env files
.env*.local

# vercel
.vercel
# Misc
.DS_Store
*.pem

# typescript
*.tsbuildinfo
next-env.d.ts
# PNPM
.pnpm-store
Empty file added .npmrc
Empty file.
36 changes: 7 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,14 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).

## Getting Started
# Stepperize

First, run the development server:
Stepperize is a powerful and flexible library for creating step-by-step workflows in your applications. It provides a simple API to define and manage steps, making it easy to build wizards, multi-step forms, and other guided processes.

## Installation

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
npm install @stepperize/react
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.

## Learn More

To learn more about Next.js, take a look at the following resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!

## Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
## Usage

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
🛠️ More documentation for README in progress...
Binary file removed app/favicon.ico
Binary file not shown.
76 changes: 0 additions & 76 deletions app/globals.css

This file was deleted.

48 changes: 0 additions & 48 deletions app/layout.tsx

This file was deleted.

Binary file removed app/opengraph-image.png
Binary file not shown.
Loading

0 comments on commit c91c217

Please sign in to comment.