https://github.com/danielcaze/multi-step-form
https://github.com/danielcaze/multi-step-form
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/danielcaze/multi-step-form
- Owner: danielcaze
- Created: 2023-02-08T15:20:57.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-08T17:02:33.000Z (over 3 years ago)
- Last Synced: 2024-12-30T04:29:52.852Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://multi-step-form-dun-eight.vercel.app
- Size: 516 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Multistep Form
A MultiStep from with reusable components.
## 🚀 Start
These instructions will allow you to get a working copy of the project on your local machine for development purposes.
### 📋 Prerequisites
What things do you need to install the software, and how to install it?
```
Node & NPM
```
### ⬇️Installing Node.Js
First of all, we will install Node.js. This is where we will run our code in the development environment. NPM will come together.
You can follow the content of the link below for a more detailed walkthrough on how to download. (Portuguese)
[Installing Node.JS](https://www.notion.so/Instalando-o-Node-js-d40fdabe8f0a491eb33b85da93d90a2f)
## 🔧 Instalations
A series of step-by-step examples that tell you what you must do to get a running development environment.
To download the project to your machine you must:
- Go to the directory where you want to install the project.
- Open the terminal in the same directory and copy & paste the command:
- `git clone https://github.com/danielcaze/multi-step-form.git`
- this will download all the files needed to run the application.
- Then in the same directory, in the terminal copy & paste:
- `npm i`
- This will download all the dependencies needed to run the application. (This process may take a while to complete, it will use your local network.)
- And finally, to run the application in your local machine, copy & paste the following command on the same directory, in the terminal:
- `npm run dev`
## 🛠️ Built with
Project was build with the stack:
* [React](https://reactjs.org/) - Javascript Library to create SPA's.
* [Styled Components](https://reactjs.org/) - Creating visual primitives for the component age.
* [React Input Mask](https://www.npmjs.com/package/react-input-mask) - Input masking component for React. Made with attention to UX.
* [React Hook Form](https://react-hook-form.com/) - Performant, flexible and extensible forms with easy-to-use validation.
* [Zod](https://zod.dev/) - TypeScript-first schema validation with static type inference.
* [Polished](https://polished.js.org/) - A lightweight toolset for writing styles.