https://github.com/nuvla/ring
Reusable ring-based application server packaged as a Docker container
https://github.com/nuvla/ring
clojure docker ring
Last synced: 4 months ago
JSON representation
Reusable ring-based application server packaged as a Docker container
- Host: GitHub
- URL: https://github.com/nuvla/ring
- Owner: nuvla
- License: apache-2.0
- Created: 2019-02-13T05:11:48.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-02-19T10:20:41.000Z (8 months ago)
- Last Synced: 2025-04-22T13:48:17.058Z (6 months ago)
- Topics: clojure, docker, ring
- Language: Clojure
- Homepage: https://sixsq.com
- Size: 153 KB
- Stars: 4
- Watchers: 7
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Nuvla Ring Container
[](https://github.com/nuvla/ring/actions/workflows/dev.yml)
[](https://github.com/nuvla/ring/actions/workflows/release.yml)
[](https://hub.docker.com/repository/docker/nuvla/ring/tags)
This repository contains the code and configuration to create a
simple, ring-based Docker container for web applications. Build from
the generated image and just add your ring handler. See the README
files in the subdirectories for more information.
## Artifacts
- `nuvla/ring` - A Docker container for simple, ring-based web
applications. Available from the [nuvla/ring
repository](https://hub.docker.com/r/nuvla/ring)
on Docker Hub.
- `com.sixsq.nuvla.ring/code` jar file: Jar file containing the ring
server code. Available from the release maven repository
maintained in AWS S3. See the `project.clj` file in the
nuvla/parent repository for the URL.
## Contributing
### Source Code Changes
To contribute code to this repository, please follow these steps:
1. Create a branch from master with a descriptive, kebab-cased name
to hold all your changes.
2. Follow the developer guidelines concerning formatting, etc. when
modifying the code.
3. Once the changes are ready to be reviewed, create a GitHub pull
request. With the pull request, provide a description of the
changes and links to any relevant issues (in this repository or
others).
4. Ensure that the triggered CI checks all pass. These are triggered
automatically with the results shown directly in the pull request.
5. Once the checks pass, assign the pull request to the repository
coordinator (who may then assign it to someone else).
6. Interact with the reviewer to address any comments.
When the reviewer is happy with the pull request, he/she will "squash
& merge" the pull request and delete the corresponding branch.
### Testing
Add appropriate tests that verify the changes or additions you make to
the source code.
### Code Formatting
The bulk of the code in this repository is written in Clojure.
The formatting follows the standard formatting provided by the Cursive
IntelliJ plugin with all the default settings **except that map
entries should be aligned**.
Additional, formatting guidelines, not handled by the Cursive plugin:
- Use a new line after the `:require` and `:import` keys in namespace
declarations.
- Alphabetize the required namespaces. This can be automated with
`lein nsorg --replace`.
- Use 2 blank lines between top-level forms.
- Use a single blank line between a block comment and the following
code.
IntelliJ (with Cursive) can format easily whole directories of source
code. Do not hesitate to use this feature to keep the source code
formatting standardized.
## Copyright
Copyright © 2019-2025, SixSq SA
## License
Licensed under the Apache License, Version 2.0 (the "License"); you
may not use this file except in compliance with the License. You may
obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied. See the License for the specific language governing
permissions and limitations under the License.