lumapps/lumX
{ "createdAt": "2014-11-19T09:28:58Z", "defaultBranch": "master", "description": "The first responsive front-end framework based on Angular & Google Material Design specifications", "fullName": "lumapps/lumX", "homepage": "https://ui.lumapps.com", "language": "JavaScript", "name": "lumX", "pushedAt": "2019-12-04T10:06:24Z", "stargazersCount": 1949, "topics": [], "updatedAt": "2025-10-23T02:07:46Z", "url": "https://github.com/lumapps/lumX"}The first responsive front-end framework based on [AngularJS][angularjs] & [Google Material Design specifications][material]. lumX will help you design your applications faster and more easily. We followed Google Material Design recommendations to bring the best experience to your users.
Quick start
Section titled “Quick start”Three quick start options are available:
- [Download the latest release][release].
- Clone the repo:
git clone https://github.com/lumapps/lumx.git. - Install with NPM:
npm install official-lumx(or Yarn:yarn add official-lumx).
Documentation
Section titled “Documentation”lumX’s documentation, included in this repo in the demo directory, is built with [Gulp][gulp] and hosted on [Google App Engine][gae] at http://ui.lumapps.com. The docs may also be run locally.
Running documentation locally
Section titled “Running documentation locally”- If necessary, install the [Python SDK of Google App Engine][gaepython].
- In your environment, declare the variable
APPENGINEwith the path to your Google App Engine binaries. For example, using bash in a Unix system with the default path will need to edit the.bashrcin your home to add:Terminal window export APPENGINE=/home/USER/google-cloud-sdk/bin/
Then install all dependencies:
- Run
npm install(oryarn install).
Then run the build system and the server:
- Run
gulp. - In an other terminal, run
./launch.sh(or./dlaunch.shif you want to use Docker, recommended on MacOS X). - Visit [http://localhost:8888][local] in your browser, and voilà.
- Run
gulp serve. - Visit [http://localhost:8080][local] in your browser, and voilà.
How to get help, contribute, or provide feedback
Section titled “How to get help, contribute, or provide feedback”Please refer to our [contributing guidelines]!(CONTRIBUTING.md). The roadmap is available in [this repo]!(ROADMAP.md).
Copyright and license
Section titled “Copyright and license”Code and documentation copyright 2018 LumApps. Code released under the [MIT license]!(LICENSE.md).
[angularjs] !: https://angularjs.org/ [gae] !: https://cloud.google.com/appengine/ [gaepython] !: https://cloud.google.com/appengine/downloads [gulp] !: http://gulpjs.com/ [local] !: http://localhost:8888 [material] !: http://www.google.com/design/spec/material-design/introduction.html [release] !: https://github.com/lumapps/lumX/tags