Skip to content

The UI for Sveditor - an SVG editor to create Github README friendly SVGs.

Notifications You must be signed in to change notification settings

JamesPatrickGill/sveditor-ui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sveditor-UI - v0.1.0 (alpha)

This project is hosted here: sveditor-ui.vercel.app

Sveditor is built to allow people to easily create and use svgs within their github project README's. This repository houses the UI aspect of this project which allows one to visually create SVG and then subsequently provides a means to consume them - namely through the Sveditor (serverless) api.

Current State of Sveditor

Sveditor, at this time, is not much more than a proof of concept. It allows a user to build SVGs out of circles and rectangles with different colours and shadows but not much more. The goal, however is to improve incrementally, I currently have the following ideas:

Immediate Improvements

  • Add the ability to rotate components when editing them.
  • Allow users to download their SVG directly from the ui.
  • Add more basic components to customise.
  • Generally add more basic components to customise.

Longer Term Goals

  • Pull the api and the ui (this repo) together into a single monorepo.
  • Add in some premade SVGs that can be used as a starting point.
  • Allow users to download a config object as a means to "save their progress" and then allow them to reupload this config to continue where they took off.
  • General improvements to UX and UI for aesthetic cohesion, ease of use and clarity.

Features

Though, despite there being much improvement to be done, there is some stuff that actually works in this proof of concept. Sveditor-UI has been used in its limited capacity to build the following cards:

It currently handles creating two SVG elements <rect> and <circle> aswell as the base <svg> tag to create a fully functioning svg.

Contribution

Due to the early stage of this project I am happy for any help getting this off the ground. If you are interested any help implementing new components or ways to edit existing components is greatly appreciated (Note: a change will be needed to the api too if svg generation is altered).

If you have a change open an RFC to claim the work and make sure I haven't already picked it up. Thanks in advance.

About

The UI for Sveditor - an SVG editor to create Github README friendly SVGs.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published