Forked with love from JS Paint created by Isaiah Odhner.
I apologize in advance for the hacks!
Install Node.js if you don't have it, then open up a command prompt / terminal in the project directory.
Run npm run lint
to check for code problems.
Run npm test
to run browser-based tests with Cypress. (It's slow to start up and run tests, unfortunately.)
Run npm run accept
to accept any visual changes.
This unfortunately re-runs all the tests, rather than accepting results of the previous test, so you could end up with different results than the previous test.
If you use GitHub Desktop, you can view diffs of images, in four different modes.
To open the Cypress UI, first run npm run test:start-server
, then concurrently npm run cy:open
Tests are also run in continuous integration with Travis CI.
Web App (https://www.thepaintproject.xyz)
After you've installed dependencies with npm i
,
use npm run dev
to start a live-reloading server.
Make sure any layout-important styles go in layout.css
.
When updating layout.css
, a right-to-left version of the stylesheet is generated, using RTLCSS.
You should test the RTL layout by changing the language to Arabic or Hebrew.
Go to Extras > Language > ุงูุนุฑุจูุฉ or ืขืืจืืช.
See Control Directives for how to control the RTL layout.
This is unreleased and not in development.
- Install dependencies with
npm i
- Start the electron app with
npm run electron:start
electron-debug and devtron are included, so you can use Ctrl+R to reload and F12/Ctrl+Shift+I to open the devtools, and there's a Devtron tab with tools specific to Electron.
You can build for production with npm run electron:make