keystonejs/keystone-5

Documentation

The Keystone 5 API documentation contains a reference for all KeystoneJS packages.

For walk-throughs and discussions, see the Keystone 5 Guides documentation.

Version control

We do our best to follow SemVer version control within Keystone. This means package versions have 3 numbers. A change in the first number indicates a breaking change, the second number indicates backward compatible feature and the third number indicates a bug fix.

You can find changelogs either by browsing our repository, or by using our interactive changelog explorer.

A quick note on dependency management: Keystone is organised into a number of small packages within a monorepo. When packages in the same repository depend on each other, new versions might not be compatible with older versions. If two or more packages are updated, it can result in breaking changes, even though collectively they appear to be non-breaking.

We do our best to catch this but recommend updating Keystone packages together to avoid any potential conflict. This is especially important to be aware of if you use automated dependency management tools like Greenkeeper.

Contributing

This project follows the all-contributors specification.

Contributions of any kind are welcome!

You will find the set-up steps in this readme and full release processes and project guidelines in CONTRIBUTING.md.

Contributors

We'd like to start by thanking all our wonderful contributors: (emoji key):

Jed Watson 💻	Jess Telford 💻	Tim Leslie 💻	Mitchell Hamilton 💻	Joss Mackison 💻	Nathan Simpson 💻	Mike 💻
John Molomby 💻 🐛	Dominik Wilkowski 💻	Ben Conolly 💻 🚧 🔧	Jared Crowe 💻	Gautam Singh 💻	lukebatchelor 💻	Ticiana de Andrade 💻
aghaabbasq 💻	Ajay Narain Mathur 💻	mshavliuk 🐛 💻	Wes Bos 📖 🤔 🚧	vlad-elagin 📖	Olya-Yer 🐛	1337cookie 📖
Mike 🤔 📆 👀 💻	Jordan Overbye 💻 📖	prvit 📖	Kennedy Baird 📖	Thiago De Bastos 📖	Daniel Cousens 📖	Simon Vrachliotis 💡 ✅ 📹
Charles Dang 💻 📖	dzigg 📖	Cristian Mos 📖	Arnaud Zheng 📖	Ashinze Ekene 📖	Fabyao 📖	Marcos RJJunior 💻
Ginkgoch 📖	MaisaMilena 📖	Martin Pham 🐛	Justin Smith 📖	Gabriel Petrovay 💻 📖	Liam Clarke 📖	Vladimir Barcovsky 💻
Caleb Gray 💻 ⚠️	frank10gm 💻	mbrodt 📖	Misha Zamkevich 💻	Matheus Chimelli 📖	Gita Permatasari Sujatmiko 📖	Andreas Borg 📖

Demo Projects

These projects are designed to show off different aspects of KeystoneJS features at a range of complexities (from a simple Todo App to a complex Meetup Site).

See the examples/README.md docs to get started.

Development Practices

All source code should be formatted with Prettier. Code is not automatically formatted in commit hooks to avoid unexpected behaviour, so we recommended using an editor plugin to format your code as you work. You can also run yarn format to prettier all the things. The lint script will validate source code with both ESLint and prettier.

Setup

Keystone 5 is set up as a monorepo, using Yarn Workspaces. Make sure to install Yarn if you haven't already.

First, clone the Keystone 5 repository

git clone https://github.com/keystonejs/keystone-5.git

Also make sure you have a local MongoDB server running (instructions).

Then install the dependencies and start the test project:

yarn
yarn dev

See examples/README.md for more details on the available demo projects.

Note For Windows Users

While running yarn on Windows, the process may fail with an error such as this:

Error: EPERM: operation not permitted, symlink 'C:\Users\user\Documents\keystone\packages\arch\packages\alert\src\index.js' -> 'C:\Users\user\Documents\keystone\packages\arch\packages\alert\dist\alert.cjs.js.flow'

This is due to permission restrictions regarding the creation of symbolic links. To solve this, you should enable Windows' Developer Mode and run yarn again.

Testing

Keystone uses Jest for unit tests and Cypress for end-to-end tests. All tests can be run locally and on GitHub.

Unit Tests

To run the unit tests, run the script:

yarn jest

Unit tests for each package can be found in packages/<package>/tests and following the naming pattern <module>.test.js. To see test coverage of the files touched by the unit tests, run:

yarn jest --coverage

To see test coverage of the entire monorepo, including files which have zero test coverage, use the special script:

yarn coverage

End-to-End Tests

Keystone tests end-to-end functionality with the help of Cypress. Each project (ie; tests/test-projects/basic, tests/test-projects/login, etc) have their own set of Cypress tests. To run an individual project's tests, cd into that directory and run:

yarn cypress:run

Cypress can be run in interactive mode from project directories with its built in GUI, which is useful when developing and debugging tests:

cd tests/test-projects/basic && yarn cypress:open

End-to-end tests live in project/**/cypress/integration/*spec.js. It is possible to run all cypress tests at once from the monorepo root with the command:

yarn cypress:run

NOTE: The output from this command will mix together the output from each project being tested in parallel. This is only recommended as sanity check before pushing code.

Code of Conduct

KeystoneJS adheres to the Contributor Covenant Code of Conduct.

License

Copyright (c) 2019 Jed Watson. Licensed under the MIT License.