Skip to content

fold-dev/fold

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Fold

Fold

Overview

Powerful, fully customizable React components for scaling your product to the next level. Supercharge your dev workflow by using our zero-dependency UI components.

Installation

# Using npm
npm install @fold-dev/core

# Using yarn
yarn add @fold-dev/core

Usage

import React from 'react';
import { FoldProvider, Heading, Button, Card, Input } from '@fold-dev/core';
import '@fold-dev/core/dist/styles.css';

const App = () => {
    return (
        <FoldProvider>
            <Card>
                <Heading>My Component</Heading>
                <Input placeholder="Enter your text" />
                <Button>Submit</Button>
            </Card>
        </FoldProvider>
    );
};

export default App;

Building

Ensure you have the following prerequisites installed:

  • Node - v18.17.1
  • Npm (Node Package Manager) - v9.6.7
  1. Clone the repository:

    git clone https://github.com/fold-dev/fold.git
  2. Navigate to the project directory:

    cd fold
  3. Install dependencies:

    npm install
  4. Developing:

    npm run dev

Documentation

For detailed information on each component and their props, please refer to our Documentation.

Theming

The library provides easy-to-use theming options. Learn more about them in the Theming Guide.

Contributing

Reporting Bugs 🐞

If you've come across a bug or an issue, please don't hesitate to open a new issue. To make the process as smooth as possible, we've created some issue templates to get you started.

Sharing Feedback πŸ“’

We'd love to get your feedback, be it suggestions, feature requests, or general thoughts on your experience. If you believe that creating a new issue isn't the best choice, don't hesitate to initiate a discussion instead.

Code of Conduct β˜€οΈ

Please note that we have a Code of Conduct that we expect everyone to follow when participating in this repository. We want to maintain a welcoming and inclusive environment for everyone.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you encounter any issues or have questions, feel free to open an issue or start a discussion.

Thank you for being part of our community, and for helping us.