tattle-made / shell-ui

A gateway into all tattle services

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Shell

A UI gateway to all tattle services

Installation

  • Clone the repository locally using - git clone git@github.com:tattle-made/shell.git

  • Open terminal and download all dependencies using npm install

  • Start the web-app using npm start

  • Install Redux Dev tools extension for you browser (Optional)

    Redux Dev tools extension

    • For Chrome visit this link
    • For Mozilla visit this link

Brief Explanation

Atoms is where foundational units of UI are defined. For instance, headings, subheadings, body texts, buttons. Atoms are UI elements that don't need further breaking down. Molecules are combination of elements from atoms that come together to form a semantically coherent UI element. For example a Search Element which combines a text field and a search button. Organisms combine molecules to create standard UI components like header, footer, sidebar, content area etc Templates are examples of pages in the app without any real content in them. They serve the purpose of checking the UI in isolation. Pages are instances of templates with data in it.

This is a good resource to read more on this topic

Development Guide

running npm start storybook will run the storybook utility in a watch mode. Making changes to files should reflect in real time. You will be able to preview components in the browser. Look at the terminal for URL (the port number changes every time you run storybook)

stories for storybook are defined in src/views/stories

Styling & Customization

Styles for various components are defined in src/views/styles/sass/ Here styles for specific component are defined in specific file for eg. style for breadcrumbs is defined in breadcrumb.scss All the custom variables are defined in themes.scss. After doing the changes in these file run npm run sass to compile the sass to css and reflect the changes in the ui.

Deploy

push to master and the website will be automatically deployed to shell.tattle.co.in

Deploy notes

  • Queue API path in useStore.js
  • shell server in shell-server.js
  • S3_AUTH_ENDPOINT in SectionSearchWhatsappPosts.js

Comment out the apt fields in config.js

About

A gateway into all tattle services


Languages

Language:CSS 72.1%Language:JavaScript 27.4%Language:HTML 0.4%Language:Shell 0.0%