Skip to content

Latest commit

 

History

History
85 lines (55 loc) · 4.16 KB

README.md

File metadata and controls

85 lines (55 loc) · 4.16 KB
Raw
........._____......._...............______....................._.
......./ ..__.\.....(_)..............|.___.\...................|.|
.......| ./..\/.___.._._.__..........|.|_/./.___...__._._.__.__|.|
.......| .|..../._.\|.|.'_.\.........|.___.\/._.\./._`.|.'__/._`.|
.......| .\__/\.(_).|.|.|.|.|........|.|_/./.(_).|.(_|.|.|.|.(_|.|
........\ ____/\___/|_|_|.|_|........\____/.\___/.\__,_|_|..\__,_|
..........................______.______...........................
.........................|______|______|..........................
           ******* Coin_Board|<Readme.md>
_____________________________________

NSP Status codecov Maintainability Build Status Greenkeeper badge

Features (Wip, already dev or future improvements) :

  • Add, track, buy and sell all kind of assets (fiat, crypto, options..) from one platform

  • Train your application to automate your cash flows (AI modules )

  • Tor hidden service docker deployment for easy access everywhere, improved security and reliability

  • MongoDB dbms with Mongoose version 5.1 finely cooked db models

  • A gorgeous and up to date documentation gracefully hosted by @github

  • A lot more to come ...

App directory structure :

All information's about how this app is organized /coded

coin_board/

All application JavaScript source files

  • coin_board/bin : Contains the main services: webview with Express & Ejs, websocket with Ws module

  • coin_board/bot/: Dedicated to the CoinBoardBot Telegram bot functionalities

  • coin_board/controllers/: Various JavaScript modules / classes for crud, crypto, user management etc

  • coin_board/params/: Ejs template rendering parameter for each route page

  • coin_board/public/: The static assets directory including client side JavaScript files

  • coin_board/routes/: Express Router overloads sub-modules

  • coin_board/Schemas/: The hot Mongoose db schemas and models

  • coin_board/views/: All the Eye-Candy, pinky, piggy, fancy stuff for app view (EJS style)*

* Note : Replacement in progress with new Angular components in AngularCoinBoard/ directory

conf/

As its name suggest, lots of configuration files like PM2 application runfile config, JSDoc conf file and doc template or Nginx, mongoDB conf and torrc files for Docker deployment.

  • conf/jsdoctemplate/ Jsdoc coin_board documentation custom template

  • conf/onion/: Hidden service Docker deployment conf files

test/

All Mocha and Chai unit testing files.

  • test/fixtures/: All fixtures

  • test/methods/: Tests for methods functions

  • test/page_mockup/: For rendering tests

  • test/routes/: Tests for router overloads functions

  • test/schemas/: Tests for mongoose schemes

Hot news :

  • Great news !!! This->app is now deployed as 'staging' test version on Heroku servers !!

  • Please find a live example of this app @ coin-board.herokuapp.com :)