Giter VIP home page Giter VIP logo

styleguide's People

Contributors

complexthings avatar ginsev avatar guypod avatar kestutis-buivydas avatar kiina avatar linasmatakas avatar mantas-kunsmanas avatar miezis avatar pauliusmaciulis avatar ronniechong avatar snyk-bot avatar vaclovasv avatar valiooo avatar vytpau avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

styleguide's Issues

Loading of font-awesome

Probably need to load font-awesome from cdn, if available. Because IIS refuses to serve .woff2 extension files by default.

Size indicators are not working correctly.

Buttons for snippet width selection do not represent widths defined in configuration. Size indicators for individual snippets work inconsistently after making it not an input field.

Copying of png files

Need to fix copying of your-logo.png, because it becomes corrupted after copying.

Create scss scrape functionality

  • Path to scss files will be defined in config file
  • To identify variables types comments will be used e.g.
    //-- Color:begin --//
    $color-red: #ff0000
    //-- Color:end --//
    //-- Fonts:begin --//
    $font-avenir: 'Avenir W01', sans-serif;
    //-- Fonts:end --//

Improve setup process

We need to improve setup process.
I think step by step guidance is not needed because most of the users want to get straight to config file.
We need to determine most critical steps that require styleguide to work.
As of right now, i see following flow:

  • download and install module.
  • setup config. It could be a part of start-styleguide task. Also, we need to cleanup config file, make it simpler, I will create new topic about that.
  • start server.

Add item count in category menu

In category meniu, we should display numbers of items in category.
Especially, this will be helpful for undefined category.

Sort undefined category to the end of the list, change visual apperance to stand out from other items.

Create snippet functionality

Snippets will have following information:

  • Name
  • Unique id
  • Category name (Snippet can be assigned to only one category)
  • Snippet code
  • Description (optional)
  • Inline CSS (optional)

Manual snippets creation and modification will done via browser window:
screenshot at may 19 09-19-02

Creating new snippet we need to generate unique id. We could have dedicated json file, where we could retrieve and store snippets ids.

Add config file

Styleguide component should have config.json file with following options:

  • admin Domains - a list of domains that allows to show edit functionality
  • categories - a list of categories of the snippets with unique id
  • watch urls - a list of pages that can be scraped or used for performance testing
  • css resources - [future feature] we need to provide project's css assets. We can scrape them directly from the site but then we need to define which domain is the main one.
  • path to styleguide
  • path to scss variables file

Add "Test component in layout" mode

Can be useful feature:

  1. User defines urls to templates
  2. Custom markers defines, where elements can be inserted into layout.
  3. User can drag/drop and remove multiple items to defined area and component can be tested in real situations.

For example, you have home layout, and defined component area in header. You can grab a slider and drop it in header area and test how component works with layout.

Color sorting in the palette

What logic is used to sort colors in the palette? Are there possibility to move black and grey colors to the end of the list?

Remove deleted snippets category

We need to remove deleted snippets category from category list. Users can access deleted page if needed but it would be invisible from navigation.

create category file

Categories will be manages by config file.
Each category going to have separate file in which snippets information will be held.
On client side going to be list of categories in the header for navigation between the pages.

screenshot at may 14 16-53-47

Fix Sass scraping.

When scraping sass and there are variables referencing to other variables - app crashes, because somehow a function is inserted into colors object.

Clean up config

We need to include CSS resources into config file as manditory option because without CSS Styleguide component becomes useless. All other options could have default values and would be as optional options.

To have Styleguide up and running user would have minimal config like this:

{
    "cssResources":[
        "/site.css",
        "/webfonts.css"
    ]
  }

Full config with default options:

{
  "cssResources":[],
  "jsResources": [],
  "categories": [
    {
      "name": "undefined",
      "id": 0
    }
  ],
  "scrapeUrls": [],
  "sassVariables": [], //renamed from sassResources  
  "resolutions": [
    1200,1024,768,480,320  //removed naming
  ],
  "database": "styleguide/db",
  "uniques": "styleguide/db/uniques.txt",
  "sassData": "styleguide/db/sassdata.txt",
  "extension": ".txt",
  "maxSassIterations": 3,
  "snippetTemplate": "styleguide/template.html",
  "serverPort": 8000
}

Create snippets scraping functionality

We need to have a away automatically create and update snippets. We going to wrap our snippets with html comments so we could later check if they were modified e.g. snippet code .

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.