https://github.com/alphagov/content-store
API for content on GOV.UK
https://github.com/alphagov/content-store
container content govuk mongodb ruby
Last synced: 4 months ago
JSON representation
API for content on GOV.UK
- Host: GitHub
- URL: https://github.com/alphagov/content-store
- Owner: alphagov
- License: mit
- Created: 2014-03-24T16:22:06.000Z (almost 12 years ago)
- Default Branch: main
- Last Pushed: 2025-08-26T11:12:45.000Z (4 months ago)
- Last Synced: 2025-08-26T14:30:00.310Z (4 months ago)
- Topics: container, content, govuk, mongodb, ruby
- Language: Ruby
- Homepage: https://docs.publishing.service.gov.uk/apps/content-store.html
- Size: 3.56 MB
- Stars: 27
- Watchers: 57
- Forks: 16
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Content Store
The Content Store is a database of almost all published content on GOV.UK.
See the [Content Store API](./docs/content-store-api.md) for basic usage.
## Technical documentation
This is a Ruby on Rails app, and should follow [our Rails app conventions](https://docs.publishing.service.gov.uk/manual/conventions-for-rails-applications.html).
You can use the [GOV.UK Docker environment](https://github.com/alphagov/govuk-docker) to run the application and its tests with all the necessary dependencies. Follow [the usage instructions](https://github.com/alphagov/govuk-docker#usage) to get started.
**Use GOV.UK Docker to run any commands that follow.**
### Running the test suite
`bundle exec rake`
### Example API output
Example API requests and corresponding responses can be found in the
[content store pact-broker documentation](https://govuk-pact-broker-6991351eca05.herokuapp.com/pacts/provider/Content%20Store/consumer/Publishing%20API/latest).
## Further documentation
- [Content Store API](./docs/content-store-api.md)
- [Publish intents](./docs/publish_intents.md)
- [Access-limited content items](./docs/access-limited-content-items.md)
- [Gone items](./docs/gone_item.md)
- [Redirect items](./docs/redirect_item.md)
## Licence
[MIT License](LICENCE)