ui-framework-jps
v2.1.12-6
Published
A simple UI framework for state management and UI components
Downloads
422
Readme
UI Framework
Table of Contents
- Project Description
- Installation Instructions
- Configuration Variables
- User Story
- Screenshot
- How To Contribute
- Technology
- Presentation
- Questions
- License
Project Description
This is a work in progress Typescript framework I am using to build simple user interfaces.
TO-DO documentation on use
Configuration Variables
API_SERVER_URL
- URL of the server completing the API calls (default blank
)
DB_URL
- address and access to the Mongo server machine
DEBUG
- activate debug output (sub-options are space separated names (e.g. server socket db api route message-queue
)
MODE
- Production
MQ_FILE
- Location of the offline message queue storage file (default ./db/queue.json
)
MQ_INTERVAL
- Milliseconds between queue persistence (default 10000
- 10 seconds)
SM_EXPIRY_CHAT
- number of minutes to keep a chat room persisted with no activity (default 43200
- 30 days)
SM_EXPIRY_SCORESHEET
- number of minutes to keep a score sheet room persisted with no activity (default 60
)
VIEW_RELATIVE_PATH
- location of the handlebars files in production, should be set to /../../
How to contribute
Please access the Questions section to send me an email, or access the repository link if you wish to help contribute to this project.
Technology
- Node.js
- NPM
- Moment
- React
- BCrypt
- Bootstrap
- Webpack
- Babel
- MongoDB
- Mongoose
- DotENV
- Git-Crypt
- Express
- Passport
- Socket.io
- Typescript
- ts-node
- tsc-watch
- ts-loader
- Chart.js
- Bootstrap 4 Round Buttons
Questions
Direct your questions about this project to:
GitHub: Github Project Link
Email: [email protected]
License
MIT License
A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.