wilsonfsouza/accordion

This is an accordion component created using React Composition Pattern to build reusable components.

Accordion Component

Table of contents

About • How to run • Technologies • Author

💻 About the project

This is an accordion component created for a code challenge. I opted to use React Composition Pattern to build compotents that are reusable.

---

🔥 Preview

The documentation was deployed on Github pages using a CI/CD pipeline. To see the component, see:

---

🚀 How to run the project

Requirements

Initial requirements: git, npm, and a code editor of your choice.

Running the application

# Clone this repository
$ https://github.com/wilsonfsouza/accordion.git

# Access the folder in your terminal/cmd/cli
$ cd accordion

# Install all dependencies
$ npm install

# Start the app in development mode
$ npm run dev

# The storybook application will open at port:6006

---

🛠 Technologies

The following tools were used in this project:

• ESLint
• Lucide React Icons
• Next.js
• React
• TailwindCSS
• Storybook
• TypeScript

See global and individual packages package.json file for more details

Use node version v21.6.0 to run this project

---

💪 How to contribute to this project

1. Fork the project.
2. Start a new branch with your changes: git checkout -b my-new-feature
3. Save it and create a commit message describing what you have done: git commit -m "feature: My new feature"
4. Send your alterations: git push origin my-feature

---

👨‍💻 Author

_{Wilson Franca}

---

Made with ❤️ by Wilson Franca 👋