Skip to content

Commit

Permalink
Add README for Resolver Test Suite and update main README
Browse files Browse the repository at this point in the history
Added a README for the upcoming Resolver Test Suite, providing a brief overview and marking it as a work in progress. Updated the main README to include new usage instructions for Resolver CE v3.0, information on the discontinued v2.6, and guidance on keeping up with the latest updates.
  • Loading branch information
nicklansley committed Jul 25, 2024
1 parent 9316cb1 commit d464e25
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ The API is available with Open API (Swagger) documentation at http://localhost:3

## What should I do next?
1. **Try it out**: To do this, use the 'setup_test.py' script in the tests folder to add some test data to the database and test Resolver. Indeed, we recommend you read through - then step through - the heavily documented test suite which will give you examples of creating / reading / deleting entries using the API, and observing behaviour through the Resolver front-end service.
2. **Review the new data entry format** in the /tests folder which gives examples of the new format for data entry - although you will be pleased to know that the API will accept v2.x format data as well.
2. **Put it to use**: You can now start using Resolver CE v3.0 in your projects. You'll be joining at least three GS1 Member Organisations who are already using Resolver CE v3.0 in various scenarios, and we are looking forward to hearing about your experiences.
3. **Review the new data entry format** in the /tests folder which gives examples of the new format for data entry - although you will be pleased to know that the API will accept v2.x format data as well.
3. **Look at the convertor scripts** in the useful_external_python_scripts folder. These scripts are useful for converting data between the previous versions of Resolver CE and the new format.
4. **Try out the API yourself**: The API is available with Open API (Swagger) documentation at http://localhost:3000/api/ and, for Postman fans (complete with example data) at https://documenter.getpostman.com/view/10078469/2sA3JKeNb2
5. **Provide feedback**: We are looking for feedback from users to help us improve the software. Please provide feedback by creating an issue on the GitHub repository.
Expand All @@ -90,3 +91,14 @@ The database is stored in a Docker volume within the composition. To back up the
```bash
docker compose exec -T database-service mongorestore --host localhost:27017 --username gs1resolver --password gs1resolver --archive=- --gzip < mongobackup.tar.gz
```

## Looking for version Resolver CE v2.6?
We've stopped development and maintenance on version 2.6, but you can still find the code in the 'v2.6' branch of this repository:<br>
https://github.com/gs1/GS1_DigitalLink_Resolver_CE/tree/v2.6

We recommend that you upgrade to version 3.0 to take advantage of the new features, simplified services and many improvements.

## Settling in with Resolver CE v3.0?
It's now time to point your code branch back to the 'master' branch to keep up with the latest updates and improvements. We are looking forward to your feedback and contributions to the project.


4 changes: 4 additions & 0 deletions test_suite/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
## Resolver Test Suite
The Resolver Test Suite, where you can test that GS1 Resolvers are GS1 Digital Link Standard compliant, is on its way and will live here!

## Work in progress!

0 comments on commit d464e25

Please sign in to comment.