If you are only interested in running the Sqlectron from the source here is the straight forward way.
After running the application if you are interested in contributing to the code base as well. Please follow these recommendations below:
Pick an issue to fix, or pitch new features. To avoid wasting your time, please ask for feedback on feature suggestions either with an issue or on the Slack channel.
Please try to write great commit messages.
There are numerous benefits to great commit messages
- They allow Sqlectron users to easily understand the consequences of updating to a newer version
- They help contributors understand what is going on with the codebase, allowing features and fixes to be developed faster
- They save maintainers time when compiling the changelog for a new release
If you're already a few commits in by the time you read this, you can still change your commit messages.
Also, before making your pull request, consider if your commits make sense on their own (and potentially should be multiple pull requests) or if they can be squashed down to one commit (with a great message). There are no hard and fast rules about this, but being mindful of your readers greatly help you author good commits.
To save everyone some time, please use EditorConfig, so your editor helps make sure we all use the same encoding, indentation, line endings, etc.
Sqlectron uses ESLint to keep consistent style. You probably want to install a plugin for your editor.
The ESLint test will be run before unit tests in the CI environment, your build will fail if it doesn't pass the style check.
npm run lintStart integration test dependencies:
./scripts/start-test-integration-deps.sh
Running in production mode:
npm run compile
DEV_TOOLS=true npm run test:e2e
Running in development mode:
npm run dev:webpack
npm run test:e2e:dev
Document based on Sinon's CONTRIBUTING.md.