Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 1.05 KB

CONTRIBUTING.md

File metadata and controls

53 lines (33 loc) · 1.05 KB
Raw

Intro

First of all, thanks for your interest in supporting this project! We could use all the help we can get to make the best possible experience for our community.

How to install locally

  1. Fork this repo

You can fork this repo by clicking here

  1. Clone on your local machine
git clone https://github.com/<USERNAME>/magicui.git
  1. Navigate to project directory
cd magicui
  1. Create a new Branch
git checkout -b my-new-branch
  1. Install dependencies
pnpm i
  1. Create .env.local file
touch .env.local && echo "NEXT_PUBLIC_APP_URL=http://localhost:3000" > .env.local
  1. Run project
pnpm dev

How to add a new component

Read the example PR to learn which files you need to add. You only need to change 5 files to add a new component or effect and it only takes around 10 minutes of work!

Ask for help

For any help or questions, please open a new github issue and we will get back to you :)