Phenix DS is lightweight user-interface framework similar to “Bootstrap, Material CSS, Foundation 5” etc & was build for simple structure, fast execution, and performance is number One concern in mind it was build for personal use and later published as open-source project for web community benefits,
Where to Start
to use and understand phenix design pattern you need to get familiar with all Utilities class names like spacing, sizing, colors, backgrounds to be able to customize and change any component used in the documentation examples and builds.
if you’re looking to quickly setup and start using Phenix D.S you can use the compiled files and include them to your html document in the next section you will find a CDN links for the “CSS & JS” compiled files you can copy them and place them into your document.
the next piece of code will load Phenix D.S Stylesheet “LTR” version from npm CDN Links you can copy it and place it into your document
<!-- Phenix CSS LTR --> <link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/phenix.css" rel="stylesheet" />
Right-to-Left (RTL) Version
if your document language is right-to-left you can use Phenix D.S Stylesheet “RTL” version from npm CDN Links you can copy it and place it into your document
<!-- Phenix CSS RTL --> <link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/phenix-rtl.css" rel="stylesheet" />
<!-- Phenix JS --> <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/phenix.js"></script>
when you put the CSS,JS togther your document code should look like the one below it is the most basic structure for Responsive & SEO Friendly WebApp.
<!DOCTYPE html> <html lang="en" dir="ltr"> <head> <!-- Essential Meta Tags --> <meta name="language" content="en"> <meta http-equiv="x-ua-compatible" content="text/html" charset="utf-8"> <meta name="robots" content="index, follow" /> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" /> <meta name="description" content="The Description of This Page Goes Right Here and its !Important" /> <meta name="keywords" content="keywords,goes,here,for,this,web,site,its,!important,and,keep,it,dynamic" /> <meta name="copyright" content="the app copyrights goes here"> <!-- Title and Favicon --> <title>Phenix Design System v1 [Tornado UI v3]</title> <link rel="shortcut icon" type="image/png" href="img/fevicon.png"> <!-- Required CSS Files --> <link href="https://unpkg.com/[email protected]/dist/css/phenix.css" rel="stylesheet" /> </head> <body> <!-- Your Code Start from Here --> <!-- Required JS Files --> <script src="https://unpkg.com/[email protected]/dist/js/phenix.js"></script> </body> </html>
you can download phenix directly as source code or compiled files to use it or include it with your favorite package managers like npm, RubyGems, etc,
phenix is available through NPM [node package manager] you will need Node.js to install and import phenix into your project with CLI
npm install phenix-ui then you can import [ TypeScript , SASS ] Modules,
after installing phenix-ui from npm you can import sass modules into you project sass with
@import './node_modules/phenix-sass/*' which will import the “*name” module into your project, for more information about SASS modules click here also,
you can import and use the TypeScript modules into your project typescript by
import Phenix from './node_modules/phenix-ts' which will import Phenix plugins for you to use it in your project,
<script type="module"> import Phenix from "./node_modules/phenix-js" || "CDN URL"; </script>