react-kawaii - GitLite

KO | EN

gitlite — search

#javascript #python #typescript #llm #golang #android #rust #linux #windows #cli #awesome-list #security #mcp #ios

react-kawaii

(★ 2,952)

Cute SVG React Components

File Explorer

Download Latest Version (.zip)

- config.json
- README.md
- FUNDING.yml
- extensions.json
- settings.json
- - .eslintignore
  - .eslintrc.js
  - .gitignore
  - .npmrc
  - .nvmrc
  - .prettierignore
  - CHANGELOG.md
  - images.d.ts
  - LICENSE.md
  - next-env.d.ts
  - next.config.js
  - package.json
  - tsconfig.json
  - turbo.json
- - nextjs.js
  - package.json
  - README.md
- - base.json
  - nextjs.json
  - package.json
  - README.md
- react-kawaii-example.gif
- react-kawaii-logo@2x.png
- - .eslintrc.js
  - .gitignore
  - CHANGELOG.md
  - package.json
  - README.md
  - tsconfig.json
- checkSubprojects.ts
.gitignore
.prettierignore
.prettierrc.js
LICENSE.md
package.json
pnpm-lock.yaml
pnpm-workspace.yaml
README.md
turbo.json

# Installation Guide

1. Get the code

git clone https://github.com/elizabetdev/react-kawaii

Downloads the entire project code from GitHub to your computer.

cd react-kawaii

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install --save react-kawaii

Downloads and installs the libraries listed in package.json.

yarn add react-kawaii

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# React Kawaii

[![Version](https://img.shields.io/npm/v/react-kawaii.svg?style=flat-square)](https://www.npmjs.com/package/react-kawaii)
![npm](https://img.shields.io/npm/dt/react-kawaii.svg)

Welcome to **React Kawaii**! This repository contains both the website and the React package.

React Kawaii is an open source library of cute SVG illustrations. Perfect if you want to give some cuteness to your React App.

<p align="center">
  <img src="https://raw.githubusercontent.com/elizabetdev/react-kawaii/main/images/react-kawaii-logo@2x.png"alt="React Kawaii Logo">
</p>

## Website

The website for React Kawaii is located in the `apps/website` directory. It serves as a documentation hub and may also include demos, tutorials, and other resources related to the project.

To start the website locally:

1. Navigate to the `apps/website` directory.
2. Install dependencies with `pnpm install`.
3. Run the development server with `pnpm start`.

## React Package

The React package, named `react-kawaii`, is located in the `packages/react-kawaii` directory. It contains the source code for the React components.

To use the `react-kawaii` package in your projects:

1. Install it from npm or yarn:

```
   npm install --save react-kawaii
   ```

or

```
   yarn add react-kawaii
   ```

2. Import the components you need in your React application:

```javascript
   import { Planet } from 'react-kawaii';

const MyComponent = () => {
     return <Planet size={200} mood="blissful" color="#FDA7DC" />;
   };
   ```

## Example

<p align="center">
  <img src="https://raw.githubusercontent.com/elizabetdev/react-kawaii/main/images/react-kawaii-example.gif?raw=true" alt="React Kawaii Example">
</p>

For detailed documentation and usage examples, visit the [React Kawaii documentation website](https://react-kawaii.vercel.app).

## Contributing

Contributions to React Kawaii are welcome! Feel free to open issues or pull requests if you have any suggestions, bug fixes, or improvements.

## License

This project is licensed under the [MIT License](LICENSE.md).