🎉 Soho XI Has Moved to Github! 🎉

Starting at the end of release 4.6.0, we moved the Soho XI codebase to Github! What this means is now anyone can view and contribute to the codebase.

There are two ways to go about using Github for development (as the Bitbucket will eventually be deprecated):

You can go to https://github.com/infor-design/enterprise and fork the repo.

Infor Design System's Enterprise Components

Infor Design System's Enterprise component library is a framework-independent UI library consisting of CSS and JS that provides Infor product development teams, partners, and customers the tools to create user experiences that are approachable, focused, relevant, perceptive.

For guidelines on when and where to use the components see the design.infor.com.

Table of Contents

Key Features
Browser Support
Getting the Code into your project
- npm
- CDN
Running the Development Project
Documentation
Contacting Us and Updates

Key Features

Themes
Responsive
Touch
Retina Ready with SVG icons
Globalization / internationalization
Security XSS
140 Components

Browser Support

We support the latest release and the release previous to the latest (R-1) for browsers and OS versions. Which maps out as follows:

IE / Edge	Firefox	Chrome	Safari	iOS Safari
IE11, Edge	R-1	R-1	R-1	R-1

Getting the code into your project

npmjs

To install, run:

npm install --save ids-enterprise

The files can then be seen in the folder ./node_modules/ids-enterprise/dist

CDN

You can now get the scripts and CSS from a CDN on AWS. For example, the paths for the 4.3.5 releases would be:

https://cdn.hookandloop.infor.com/sohoxi/4.3.5/dist/js/sohoxi.js
https://cdn.hookandloop.infor.com/sohoxi/4.3.5/dist/js/sohoxi.min.js
https://cdn.hookandloop.infor.com/sohoxi/4.3.5/dist/css/dark-theme.css
https://cdn.hookandloop.infor.com/sohoxi/4.3.5/dist/css/dark-theme.min.css
https://cdn.hookandloop.infor.com/sohoxi/4.3.5/dist/css/dark-theme.css
https://cdn.hookandloop.infor.com/sohoxi/4.3.5/dist/css/dark-theme.min.css
https://cdn.hookandloop.infor.com/sohoxi/4.3.5/dist/css/light-theme.css
https://cdn.hookandloop.infor.com/sohoxi/4.3.5/dist/css/light-theme.min.css
https://cdn.hookandloop.infor.com/sohoxi/4.3.5/dist/svg/svg.html
https://cdn.hookandloop.infor.com/sohoxi/4.3.5/dist/svg/svg-extended.html

Versions available on CDN are: 4.3.2, 4.3.3, 4.3.4, 4.3.5

Note: There may be a cost involved to using this with Infor's amazon s3 account so keep this in mind when using.

Running the development project

Install pre-requisites

Install node for following the directions for your OS
On Windows, you'll need to install Python. Make sure the version is at least 2.5.0 but not Python 3.
Also on Windows, you should run git config core.autocrlf false

Clone the repo

Clone the repo using git: git clone https://github.com/infor-design/enterprise.git
cd into the repo directory
Then npm install to install node packages. On macOS you may need sudo npm install as some packages require elevated permissions
Then npm run install-globals to install some global packages we use

Running the app

From within the project folder:

Run npx grunt to compile initial assets
Run npm start to start the web server
Make a new terminal window and from within your project folder run npx grunt watch to watch for any file changes and rebuild
Open up localhost:4000 in a browser to see the local app

Note that at this point any changes you make will cause SASS to recompile and the browser will reload.

Running the tests

Functional tests are the primary way we test the codebase. To run the tests, run npm run functional:local.

Editor Plugins

This project uses eslint and editorconfig. You may want to add the following plugins to your editor to help comply with our coding standards: eslint for Atom and VS Code, as well as editorconfig for Atom and VS Code

Documentation

Soho XI's current documentation can be found at design.infor.com/code/ids-enterprise/latest.

You can also find a subset of documentation at localhost:4000/components when running the project locally. To contribute you can edit the readme.md files for a component or add JSDocs comments to the source files for inline settings and events.

Contacting Us and Updates

This project is an open source project. Please see the contribution guidelines for this project.

Please use the internal Infor Jira issue tracker to report all requests, bugs, questions, and feature requests.

For release updates see our upcoming and past version in our releases road map.

If you're an Infor employee, you can join our MS Teams Group for updates.

mliq / enterprise Goto Github PK

enterprise's Introduction