Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hmcts/ccd-case-activity-api
https://github.com/hmcts/ccd-case-activity-api
hmcts-ccd jenkins-cft jenkins-cft-a-c
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/hmcts/ccd-case-activity-api
- Owner: hmcts
- Created: 2018-03-15T11:12:09.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T14:04:11.000Z (about 2 months ago)
- Last Synced: 2024-10-29T17:11:57.560Z (about 2 months ago)
- Topics: hmcts-ccd, jenkins-cft, jenkins-cft-a-c
- Language: JavaScript
- Size: 2.96 MB
- Stars: 1
- Watchers: 31
- Forks: 2
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
Awesome Lists containing this project
README
# ccd-case-activity-api
[](https://opensource.org/licenses/MIT)
[](https://travis-ci.org/hmcts/ccd-case-activity-api)
[](https://codecov.io/gh/hmcts/ccd-case-activity-api)
[](https://www.codacy.com/app/adr1ancho/ccd-case-activity-api?utm_source=github.com&utm_medium=referral&utm_content=hmcts/ccd-case-activity-api&utm_campaign=Badge_Grade)
[](https://snyk.io/test/github/hmcts/ccd-case-activity-api)
[](#ccd-activity-api)
[](http://issuestats.com/github/hmcts/ccd-case-activity-api)
Real-time tracking of case activity (viewers, editors,...)
## Quickstart
```
$ git clone https://github.com/hmcts/ccd-case-activity-api.git
$ cd ccd-case-activity-api
$ yarn install
$ yarn start
```
## Setup Redis with Docker
To pull the latest docker image from docker store just type:
```
$ docker pull redis
```
After getting the latest redis you may start your redis image by the following command
```
$ docker run --name ccd-redis -p 6379:6379 -d redis
```
You can connect to redis-cli to manually execute some redis commands by connecting to the interactive terminal of your docker container.
to do this first you need to acquire the container id via the `docker ps` command:
```
fatiho@sardis:~/Documents/hmcts/ws-webstorm/ccd-case-activity-api (RDM-963/RDM-1078)$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
ef697aec3454 docker.artifactory.reform.hmcts.net/docker/ccd/ccd-data-store "/entrypoint.sh --..." 13 days ago Up 8 days (healthy) 0.0.0.0:4000->4000/tcp ccd-data-store
e7dc23c65e51 docker.artifactory.reform.hmcts.net/docker/ccd/ccd-postgres "docker-entrypoint..." 13 days ago Up 8 days 0.0.0.0:5432->5432/tcp ccd-postgres
8a1fd6f05643 redis "docker-entrypoint..." 2 weeks ago Up 4 days 0.0.0.0:6379->6379/tcp ccd-redis
```
Once you get the Container Id run the following command with proper container id
```
$ docker exec -it 8a1fd6f05643 /bin/bash
```
Now you are in. You can run `redis-cli` to access the Redis Command Line Interface and execute commands like GET, SET, etc.
See [redis documentation](https://redis.io) for details
## Config
Configuration is achieved through [node-config](https://github.com/lorenwest/node-config).
## Unit tests
The tests can be run using:
```
$ yarn test
```
## End to End tests
The end to end tests require a running instance of Redis. Beware before each test all keys in Redis are removed.
The tests can be run using:
```
$ yarn test:end2end
```
## Functional Tests
The functional tests are located in `aat` folder. The tests are written using
befta-fw library. To find out more about BEFTA Framework, see the repository and its README [here](https://github.com/hmcts/befta-fw).
The tests can be run using:
```
$ yarn test:functional
```
or to run using gradle directly:
```
$ cd ./aat/
$ ./gradlew functional
```
## Some notes on development and test config
You need to set the NODE_ENV to make use of environment configuration and DEBUG to see the logs when you run the server
```
$ export NODE_ENV=dev
$ export DEBUG='ccd-case-activity-api:*'
$ yarn start
> [email protected] start /Users/fatiho/Documents/hmcts/ws-webstorm/ccd-case-activity-api
> node ./bin/www
ccd-case-activity-api:app starting application with environment: dev +0ms
ccd-case-activity-api:server Listening on port 3000 +19ms
ccd-case-activity-api:redis-client connected to Redis +7ms
```