Documint is a cross-platform application for writing and managing your project documentation.
The client app project is located in the documint directory in the root of the repostitory.
src - contains main logic in TypeScript
src/main - contains 'main' Electron script [.ts]
src/renderer - contains 'renderer' Electron script [.ts]
src/react - contains React layout components [.tsx]
src/redux - contains Redux components (store, actions, reducers, etc...) [.ts]
sass - contains SASS styles [.sass, .css]
static - contains static files (index.html, fonts, etc.)
resources - contains additional resources, included in dist/resources when packaging app
The following directories are generated when building or packaging the app
(app) - created with yarn build, contains .js files compiled from src
(styles) - created with yarn build, contains style.css compiled from sass
(dist) - created with yarn dist, contains packaged app binaries
yarn build - compiles TypeScript into JavaScript (/src -> /app) and SASS into CSS (/sass -> /style)
yarn start - performs build and starts Electron app
yarn dist - performs build and creates platform-specific Electron binaries for distribution (config defined in package.json > "build")
The remote host app project is located in the documint-remote directory in the root of the repostitory.
index.js - entry point for project, Express.js app setup
/routes - Express routes
/auth - Auth related utilities
config.json - configure host settings (serverPort and password)
node . - run server
This project is licenced under the MIT License.