- Fork/Clone
- Install dependencies - npm install
- Fire up Postgres on the default ports
- Make configuration/config.json file (see config.json.example)
- npm run dev for dev, npm run build (vs script package.json)
- If database not exists the program create it.
The project run under nodeJS.
Is 100% typescript, the javascript is used for TDD only and apidoc.
For views a little :
📦src
┣ 📂server // API Server
┃ ┣ 📂configuration // Configuration Server
┃ ┃ ┣ 📜.key // crypt Key
┃ ┃ ┗ config.json // config file
┃ ┣ 📂db
┃ ┃ ┣ 📂createDBDatas // datas to create blank Database
┃ ┃ ┣ 📂dataAccess
┃ ┃ ┣ 📂entities // SensorThings entities
┃ ┃ ┣ 📂helpers
┃ ┃ ┣ 📂interfaces
┃ ┃ ┗ 📜constants.ts // Constants for DB
┃ ┣ 📂helpers // Application helpers
┃ ┣ 📂logger // Logs tools
┃ ┣ 📂lora // Specific lora entity
┃ ┣ 📂odata // Odata decoder
┃ ┃ ┣ 📂parser // Odata parser
┃ ┃ ┗ 📂visitor // Odata decoder process
┃ ┃ ┗📂helpers
┃ ┣ 📂public // public HTTP pages
┃ ┣ 📂routes // routes API
┃ ┃ ┣ 📜favicon.ico // Icon
┃ ┃ ┣ 📜protected.ts // protected routes
┃ ┃ ┗ 📜unProtected.ts // open routes
┃ ┣ 📂types // data types
┃ ┣ 📂views // generated views
┃ ┃ ┣ 📂admin // admin pages
┃ ┃ ┣ 📂css // CsS filse
┃ ┃ ┣ 📂graph // graph views
┃ ┃ ┣ 📂helpers
┃ ┃ ┣ 📂js // JS filse
┃ ┃ ┣ 📂maker // Query maker
┃ ┃ ┗ 📂query // Query view
┃ ┣ 📜constants.ts // App constants
┃ ┣ 📜db.ts // DB connection(s)
┃ ┗ 📜index.ts // starting file
┣ 📂template // ApiDoc template
┣ 📂test
┃ ┣ 📂integration // Tests
┃ ┃ ┗ 📂files // files For importation tests
┃ ┣ 📜apidoc.json // Apidoc configuration
┃ ┗ 📜dbTest.ts // DB test connection
┗ 📜build.js // js file for building app