The JSON:API server powering Ceevee.
Local development using Docker is recommended. When using Docker, attached services (such as MongoDB) are managed automatically. Although working directly in Node is possible (e.g. in CI), this README assumes Docker.
NPM is used to issue commands to Docker. In general, appending container:
to an NPM command executes it within Docker.
To install all modules listed in package.json:
npm run container:install
To install and add packages to dependencies:
npm run container:install package-name
To install and add packages to devDependencies:
npm run container:install-dev package-name
Lint all:
npm run container:lint
Lint against Codeclimate:
npm run container:lint:codeclimate
Lint ES source with:
npm run container:lint:es
Check that all dependencies have acceptable licenses:
npm run container:lint:licenses
Report on all licenses in use:
npm run container:lint:licenses:report
All tests must pass and test coverage must be at least 100% for the test script to succeed. Run tests locally:
npm run container:test
With coverage reporting:
npm run container:test:coverage
The script automatically restarts whenever changes are detected or a crash occurs. This command runs the application directly under Node using the experimental modules feature:
npm run container:start
The following environment variables are used by the application. Default values are used when a variable is not set.
| Variable | Default | Description |
|---|---|---|
MONGODB_URI |
URL of the MongoDB instance to which to connect |
Contributions consistent with the style and quality of existing code are welcomed. Be sure to follow the guidelines below.
Check the issues page of this repository for available work.
This project follows a successful git branching model and uses commitizen and cz-conventional-changelog. Commitizen helps to ensure that commit messages remain well-formatted and consistent across different contributors.
Before committing for the first time, globally install commitizen
and cz-conventional-changelog on your host machine:
npm install -g commitizen cz-conventional-changelog
Create a .czrc file in your home directory, with path referring to the preferred, globally installed, commitizen adapter:
echo '{ "path": "/path/to/cz-conventional-changelog" }' > ~/.czrc
Watch a helpful video about commitizen, but follow the directions here for actual usage within this project.
To start work on a new change, pull the latest develop and create
a new topic branch (e.g. feature-resume-model, chore-test-update,
bugfix-bad-bug). Work should be committed to
topic branches only, never directly to mainline branches.
To begin a commit, stage changes as usual:
git add .
To commit, run the following command (instead of git commit) and follow the
directions:
npm run commit
When committing in this manner, tests are executed automatically and all tests must pass before the commit can be finalized. If tests fail, please address the issue(s) and try the commit procedure again.
We recommend making incremental commits at logical stopping points whenever possible, rather than large monolithic commits at the end of a feature.
When a topic branch is ready to merge, submit a pull request from the topic
branch into develop via GitHub. Pull requests are automatically tested in CI
and may only be merged after all checks pass successfully. At that time,
a core team member may merge the PR into develop.
Commit messages and pull requests should short link to GitHub issues when referencing information in the issue; though not every commit or PR related to an issue needs to reference it. Commits and PRs that fix or resolve an issue should close the issue in the message.