Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hmcts/ccd-user-profile-api
User preferences for CCD UI
https://github.com/hmcts/ccd-user-profile-api
hmcts-ccd jenkins-cft jenkins-cft-a-c
Last synced: about 1 month ago
JSON representation
User preferences for CCD UI
- Host: GitHub
- URL: https://github.com/hmcts/ccd-user-profile-api
- Owner: hmcts
- License: mit
- Created: 2018-03-15T11:09:36.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-11-15T10:32:46.000Z (about 1 month ago)
- Last Synced: 2024-11-15T11:29:17.864Z (about 1 month ago)
- Topics: hmcts-ccd, jenkins-cft, jenkins-cft-a-c
- Language: Java
- Homepage:
- Size: 8.56 MB
- Stars: 3
- Watchers: 26
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ccd-user-profile-api
[](https://hmcts.github.io/cnp-api-docs/swagger.html?url=https://hmcts.github.io/cnp-api-docs/specs/ccd-user-profile-api.json)
[](https://opensource.org/licenses/MIT)
[](https://travis-ci.org/hmcts/ccd-user-profile-api)
[](https://hub.docker.com/r/hmcts/ccd-user-profile-api)
[](https://codecov.io/gh/hmcts/ccd-user-profile-api)
[](https://www.codacy.com/app/adr1ancho/ccd-user-profile-api?utm_source=github.com&utm_medium=referral&utm_content=hmcts/ccd-user-profile-api&utm_campaign=Badge_Grade)
[](https://www.codacy.com/app/adr1ancho/ccd-user-profile-api?utm_source=github.com&utm_medium=referral&utm_content=hmcts/ccd-user-profile-api&utm_campaign=Badge_Coverage)
[](https://snyk.io/test/github/hmcts/ccd-user-profile-api)
[](#ccd-user-profile-api)
UI preferences for Core Case Data users.
____
## Getting started
### Prerequisites
- [Open JDK 21](https://openjdk.java.net/)
- [Docker](https://www.docker.com)
#### Environment variables
The following environment variables are required:
| Name | Default | Description |
|------|---------|-------------|
| USER_PROFILE_DB_USERNAME | - | Username for database |
| USER_PROFILE_DB_PASSWORD | - | Password for database |
| USER_PROFILE_S2S_AUTHORISED_SERVICES | ccd_data,ccd_definition,ccd_admin | Authorised micro-service names for S2S calls |
| IDAM_S2S_URL | - | Base URL for IdAM's S2S API service (service-auth-provider). `http://localhost:4502` for the dockerised local instance or tunneled `dev` instance. |
| AZURE_APPLICATIONINSIGHTS_INSTRUMENTATIONKEY | - | For CNP environment this is provided by the terraform scripts. However any value would do for your local environment. |
### Building
The project uses [Gradle](https://gradle.org/).
To build project please execute the following command:
```bash
./gradlew clean build
```
### Gradle Upgrades
It is important to run the following command and commit the updated `gradle-wrapper.jar` to the repository for proper gradle upgrades
```bash
# this sample is for v4.9 replace with correct upgrade version
./gradlew wrapper --gradle-version 4.9 --distribution-type all
```
### Running
If you want your code to become available to other Docker projects (e.g. for local environment testing), you need to build the image:
```bash
docker-compose build
```
The above will build both the application and database images.
If you want to build only one of them just specify the name assigned in docker compose file, e.g.:
```bash
docker-compose build ccd-user-profile-api
```
When the project has been packaged in `target/` directory,
you can run it by executing following command:
```bash
docker-compose up
```
As a result the following containers will get created and started:
- Database exposing port `5453`
- API exposing ports `4453`
#### Handling database
Database will get initiated when you run `docker-compose up` for the first time by execute all scripts from `database` directory.
You don't need to migrate database manually since migrations are executed every time `docker-compose up` is executed.
You can connect to the database at `http://localhost:5453` with the username and password set in the environment variables.
### API
Their are currently 2 endpoints:
- POST /user-profile/users - this is used to create a User Profile as well as it's associated Jurisdictions. At least one Jurisdiction must be defined in order to create a User Profile. Also, there is currently no way to amend a User's Jurisdictions other than manually removing them from the database and creating a new User.
- GET /user-profile/users/{uid}/jurisdictions - this is used to retrieve a String[] of Jurisdictions ID for the given User ID.
#### Create a User
To create a user the following example JSON can be used:
```json
{
"id" : "user1",
"jurisdictions" : [{
"id" : "TEST1"
}, {
"id" : "TEST2"
}
]
}
```
### 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).
## LICENSE
This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.