Skip to content

A little application developed with Web Components using Lit-Element, Rollup, Stylus and a little bit of material design concept.

Notifications You must be signed in to change notification settings

danielbarion/instruct-contacts

Repository files navigation

Instruct Contact App

Instruct Contacts APP

Demo: https://friendly-bose-005e60.netlify.com/

Recommended OS: Linux, OS X. You can test this app in Windows but you maybe need install linux sub system or use git bash to improve compatility and execute scripts.

Informations

This project use web components concept to have a high performance like native elements. All components are build with HTML, CSS (Stylus), Javascript.

Behind the scenes we have a open source project Lit-Element that I'm contributing to the documentation.

  • Components

All components has a wc prefix

  • Modules

All modules has a instruct prefix

Available Scripts

Before anything you need install all dependencies:

  • Yarn
yarn
  • npm
npm install

Development

yarn start

This command will run development steps into source code and serve with Browserify.

Development

yarn start-stand-alone

If you prefer serve the app more static, you can use this command and use serve to access the app. This command will run development steps into source code and will not run browserify.

  • NPM
npm i -g serve
  • Yarn
yarn global add serve

Once that's done, you can run this command inside your project's directory:

serve build -l 3005

Where build is the folder and 3005 is the port.

Production

yarn build

This command will run production steps (minify, uglify and no source map) and will not serve the app. To test you can serve the app as your want in your server or use serve like the stand alone flow.

Tests

First, add Jasmine to your enviroment, I strongly recommend add jasmine global:

npm i -g jasmine

Now you just need run the command below:

yarn test

About

A little application developed with Web Components using Lit-Element, Rollup, Stylus and a little bit of material design concept.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published