Giter Site home page Giter Site logo

motley's Introduction

Motley

Build Status

This project is just a bundle of common CSS that we use accross our frontend applications at Coding Blocks. It is based on ITCSS architecture and written using Sass. The purpose of this project is to make process of developing HTML and CSS loosely coupled with actual frontend project to allow easy contribution and scalability in terms of development effort.

Demo

https://coding-blocks.github.io/motley

Building and Running Motley Locally

Building and running Motley in your local dev environment is very easy. Be sure you have Node.js and Yarn installed, then follow the directions below.

  1. Clone the source code

git clone https://github.com/coding-blocks/motley.git

  1. Change directory to motley and Install development dependencies

cd motley

yarn install

  1. Run a local development server

yarn start

Motley will start running on localhost:9000.

Directory Structure

 | sass/styles     contains sass files
 | examples
   - public        contains static assets
   - components    contains individual components
                   these are registered as partials and can be used in pages or other components
   - views         Individual pages, gets build into examples/html/*.html files

See Motley in Action

Motley is used in the following websites -

  1. Coding Blocks Online
  2. Hacker Blocks
  3. Coding Blocks Account Dashboard

Maintainers

  1. Bipin Kalra
  2. Vibhu Dujari
  3. Abhishek Gupta

motley's People

Contributors

aayusharora avatar abhishek97 avatar aditya41 avatar ananay avatar architkshk avatar arunteltia avatar bhavyaagg avatar bipinkalra avatar championswimmer avatar dhroov7 avatar firefinchdev avatar himankbhalla avatar ishaandhamija avatar jatinkatyal13 avatar lazy-god avatar prajjwal avatar rishabh570 avatar sd5869 avatar thomasvaeth avatar vdvibhu20 avatar vibhorgupta-gh avatar witty123 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

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

motley's Issues

Documentation of Framework

Propose the best way to document this framework.
The codebase is split up into two major layers

elements: They are independent skeleton that are used to make objects
objects: They are the combination of elements along with the layer of layouting

PS: Some of the elements do not require to be used as an object, hence they should also be documented.

There is an approach needed to document each and every object/element that is complete in itself.
For example:
Documenting a card means:
[ HTML Code + CSS code ] represented in a well defined UI, so that anyone can use that card ( i.e making it reusable )
There should be a static page that can document each of our complete elements/objects.

  • Propose a way to document Motley elements/objects

  • Document the cards and buttons element/objects

For reference:
Check how the element section of semantic-ui is documented
https://semantic-ui.com/elements/button.html

Course Card on Hover gets trimmed off

course card on hover in recommended courses section scales beyond boundaries and is trimmed off . One more thing scaling on hover should be slow according to me

Refactor

Refactor motley to follow ITCSS.

Elements layer should only have html elements.
Extra objects present in elements layer (ex searchbox) should go into object layer.
What we have in object layer now is a mixture of objects and components. Create a separate layer for components.
Classes currently prefixed with o- in object layer must be prefixed with c- in the component layer.
Take help from this blog to decide what should be an object and what should be a component.
https://www.xfive.co/blog/itcss-scalable-maintainable-css-architecture/

Fix travis build

The travis build is failing, probably due to different node version. Node 8 LTS should be used build this project.

Refactor Components

If you look at the examples directory, you'll see that currently, we have only one component -> nav-bar.hbs. Ideally, we would want to move each isolated component to separate hbs file and there use it as partial (the {{> nav-bar}} syntax) in all the pages(views)

Components to refactor (will update the list):

  • Course Card
  • Footer
  • Button
  • Accordion

BOSS: Bounty applies to each component refactored, i.e 100 Bounty points each. Make separate PR.

Background image used in the styles are not part of the project

It looks like the background images used in the styles, such as fingerprint.svg are not part of the project, at least not the one uploaded to NPM. So when the stylesheet loads, it results in 404 errors. These should be bundled as part of the project and the paths to them should be referenced in such a way that they will work relative to the dist folder.

IDE mobile view

Make mobile view for code-challenge content for online.codingblocks.com

Only the problem/submissions/leaderboard should be visible for mobile. Basically this part

screen_shot_2018-08-13_at_6_50_10_pm

Also a text - "To solve this problem, please use a desktop."

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.