Skip to content

dyne/luigi

Repository files navigation

────▄████▄▄ 
───▄▀█▀▐└─┐ 
───█▄▐▌▄█▄┘ 
───└▄▄▄▄─┘ 
▄██████████▄ 
▒▒█▄████▄█▒▒ 
──███▀▀███ 
▄███────███▄ 
    

Luigi van der Dyne
Design tool for hackers



This software is meant for the Dyne.org hackers that want to easily implement assets and follow the new design rules of Dyne.org.

To use it head your browser to https://luigi.dyne.org/

🚩 Table of Contents (click to expand)

🎮 Quick start

To start using Luigi van der Dyne just https://luigi.dyne.org/

Adding new formats

1. Create a new design function

First, running a command that will ask you a couple of questions to create a new design functions from a base (template, example or blank):

yarn new

Choose

❯ Template
❯ React Image (SVG)

And give it a proper name (eg. event_twitter_card, linkedin_banner...), this will be the name of the template asset and the folder in which we now have to work, let's say it's called listen_to_podcast

2. Insert the layout

So in Luigi everything works in svg ;) Let's go and find some awesome .svg layouts in our figma projects and export it as shown below:

howto_2

Options show be as follow:

  • Include 'id' attributes
  • Outline text

specially is important to Uncheck Outline text

Now export the svg copy the content inside the file and paste it into your new created functions/listen_to_podcast/index.js

at line 11-13 replace

  return (
    <svg width={width} height={height}>
      <rect fill={color} width={width} height={height} />
    </svg>
  );
};

with

  return (
    // The content of the svg exported just previously described as of this guide ;p
    // Something like:
    <svg width="1200" height="675" viewBox="0 0 1200 675" fill="none">
       ...
    </svg>
  );
};

3. Run the app locally

Now in the root project run the server with the following command

yarn dev

head your browser to http://localhost:3000 so you can already see your new template and to see that in actions

4. Define the inputs

Add the control inputs as describe in add-an-input if you have problems with images please refer to this issue designsystemsinternational/mechanic#130 or take inspiration on how I did it on ./functions/event-card/index.js

5. Replace placeholders with inputs

Now that you defined the inputs you can replace the variable name you decided for the inputs inside the svg, search the text / images you want to replace and put the variable names like:

{title}

🔝 back to top


😍 Acknowledgements

software by Dyne.org

Copyleft (ɔ) 2022 by Dyne.org foundation, Amsterdam

Designed, written and maintained by Puria Nafisi Azizi aka @pna.

Special thanks to:

  • @Jaromil that did need a simple tool and is not able to use crappy complicated software design tools
  • Tomato 🍅 and Franziska von Guten for the hard creative work, the asset templates and the design rules
  • @bbtgnn to point me to mechanid.design

🔝 back to top


🌐 Links

https://luigi.dyne.org/

https://github.com/designsystemsinternational/mechanic

🔝 back to top


👤 Contributing

Please first take a look at the Dyne.org - Contributor License Agreement then

  1. 🔀 FORK IT
  2. Create your feature branch git checkout -b feature/branch
  3. Commit your changes git commit -am 'Add some fooBar'
  4. Push to the branch git push origin feature/branch
  5. Create a new Pull Request
  6. 🙏 Thank you

🔝 back to top


💼 License

Luigi van der Dyne - Design tool for hackers
Copyleft (ɔ) 2021 Dyne.org foundation, Amsterdam

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

🔝 back to top

About

Design tool for hackers

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published