An open API service indexing awesome lists of open source software.

https://github.com/tmunz/goldenseeds

Application to generate SVGs on mathimatical rules
https://github.com/tmunz/goldenseeds

art creator fibonacci parametric parametric-design parametric-modelling react svg svg-generator unknown-pleasures

Last synced: 11 months ago
JSON representation

Application to generate SVGs on mathimatical rules

Awesome Lists containing this project

README

          

# GoldenSeeds Parametric SVG Generator

[![license](https://img.shields.io/github/license/tmunz/GoldenSeeds.svg)](LICENSE)
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

GoldenSeeds SVG Generator is a web-based application for creating SVG graphics using rule-based mathematical principles (parametric modelling). The application supports various types of graphic generation techniques and allows for saving, exporting, and customizing vector graphics.
**[Try it yourself](https://tmunz.github.io/GoldenSeeds/)**

![image](./example.png)

## Table of Contents

- [Features](#features)
- [Install](#install)
- [Usage](#usage)
- [Development](#development)
- [Issues](#issues)
- [Contributing](#contributing)
- [License](#license)

## Features

- Rule-based vector graphics creation.
- Multiple graphic generators including:
- Cartesian or polar grids.
- Regular shapes.
- Text, trees, and Voronoi diagrams.
- Ability to combine different generators for complex drawings.
- Save drawings within the app.
- Open and save configurations for reproducible drawings.
- Export drawings as SVG or PNG.
- Progressive Web App (PWA) capabilities.
- Themeable interface for a customizable look and feel.

## Install

This project requires Node.js (tested for version 18.14.1) and npm. Clone the repository and install dependencies with the following commands:

```bash
git clone https://github.com/tmunz/GoldenSeeds.git
cd GoldenSeeds
npm install
```

## Usage

To start the development server:

```bash
npm run start
```

To build the project for production:

```bash
npm run build
```

To run tests:

```bash
npm run test
```

## Development

The project is developed with the following technologies:
- **React**: For building the user interface.
- **Opentype.js**: For handling font-related functionality.
- **RxJS**: For reactive programming and managing data flow.
- **React Beautiful DnD**: For drag-and-drop interactions.
- **Webpack**: For bundling the project.

It uses various development dependencies for code linting, testing, and building, including Babel, TypeScript, and ESLint.

## Issues

For known issues or to report a bug, see the [Open Issues](https://github.com/tmunz/GoldenSeeds/issues) on GitHub.

## Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch with a descriptive name.
3. Make your changes and commit them.
4. Submit a pull request.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

---

This README follows the [standard-readme](https://github.com/RichardLitt/standard-readme) specifications. If making changes to this README, please conform to the specification requirements.