diff --git a/README.md b/README.md index 78856ff4..d1ba362d 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@

- An open, extensible, knowledge base for your team built using React and Node.js.
Try Outline out using our hosted version at www.getoutline.com.
+ An open, extensible, knowledge base for your team built using React and Node.js.
Try out Outline using our hosted version at www.getoutline.com.

- Outline + Outline

@@ -12,7 +12,7 @@

-This is the source code that runs **Outline** and all the associated services. If you want to use outline then you don't need to run this code, we offer a hosted version of the app at [getoutline.com](https://www.getoutline.com). +This is the source code that runs [**Outline**](https://www.getoutline.com) and all the associated services. If you want to use outline then you don't need to run this code, we offer a hosted version of the app at [getoutline.com](https://www.getoutline.com). If you'd like to run your own copy of Outline or contribute to development then this is the place for you. @@ -84,6 +84,23 @@ Backend is driven by [Koa](http://koajs.com/) (API, web server), [Sequelize](htt - `server/presenters` - API responses for database models - `shared` - Code shared between frontend and backend applications +## Tests + +We aim to have sufficient test coverage for critical parts of the application and aren't aiming for 100% unit test coverage. All API endpoints and anything authentication related should be thoroughly tested, and it's generally good to add tests for backend features and code. + +To add new tests, write your tests with [Jest]https://facebook.github.io/jest/() add a file with `.test.js` extension next to the tested code. + +```shell +# To run all tests +yarn test + +# To run backend tests +yarn test:server + +# To run frontend tests +yarn test:app +``` + ## Contributing Outline is still built and maintained by a small team – we'd love your help to fix bugs and add features!