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

1. Node.js
2. NPM
4. Moment
5. React
6. BCrypt
7. Bootstrap
8. Webpack
9. Babel
10. MongoDB
11. Mongoose
12. DotENV
13. Git-Crypt
14. Express
15. Passport
16. Socket.io
17. Typescript
18. ts-node
19. tsc-watch
20. ts-loader
21. Chart.js
22. Bootstrap 4 Round Buttons

Questions

> Direct your questions about this project to:
>
> GitHub: Github Project Link
>
> Email: jamie.sharples@gmail.com

License

$3

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.