From a62d35fe03cb806615e7ab91a60cc630d78587d7 Mon Sep 17 00:00:00 2001 From: Sepand Ansari Date: Mon, 29 Oct 2018 23:08:36 -0400 Subject: [PATCH] Move test documentation to development.md --- developer_docs/development.md | 7 +++++++ developer_docs/installation.md | 3 --- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/developer_docs/development.md b/developer_docs/development.md index c94f2e3d..e26dcb56 100644 --- a/developer_docs/development.md +++ b/developer_docs/development.md @@ -5,6 +5,11 @@ A guide for adding code to this project. ## Installation Follow the [installation guide](https://github.com/processing/p5.js-web-editor/blob/master/developer_docs/installation.md). +## Tests +To run the test suite simply run `npm test` (after installing dependencies with `npm install`) + +A sample unit test could be found here: [Nav.test.jsx](../client/components/__test__/Nav.test.jsx). + ## Design Design proposed and theme changes are present at: [Zeplin](https://scene.zeplin.io/project/55f746c54a02e1e50e0632c3). @@ -23,3 +28,5 @@ Design proposed and theme changes are present at: [Zeplin](https://scene.zeplin. - For reference to the JavaScript style guide, see the [Airbnb Style Guide](https://github.com/airbnb/javascript), [React ESLint Plugin](https://github.com/yannickcr/eslint-plugin-react). - The ESLint configuration is based on a few popular React/Redux boilerplates. Open to suggestions on this. If in development, you're getting annoyed with ESLint, you can temporarily remove the `eslint-loader` it from `webpack/config.dev.js` in the JavaScript loader, or disable any line from eslint by commenting at the end of the line `// eslint-disable-line`. + + - [Jest](https://jestjs.io/) for unit tests and snapshot testing along with [Enzyme](https://airbnb.io/enzyme/) for testing React. \ No newline at end of file diff --git a/developer_docs/installation.md b/developer_docs/installation.md index 7c8a9fc2..21fc18fa 100644 --- a/developer_docs/installation.md +++ b/developer_docs/installation.md @@ -29,9 +29,6 @@ Follow these instructions to set up your development environment, which you need 11. Install the [React Developer Tools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en) 12. Open and close the Redux DevTools using `ctrl+h`, and move them with `ctrl+w` -## Tests (in progress) -Run `npm test` - ## Docker Installation Using Docker, you can have a complete, consistent development environment without having to manually install dependencies such as Node, Mongo, etc. It also helps isolate these dependencies and their data from other projects that you may have on the same computer that use different/conflicting versions, etc.