https://github.com/upb-code-labs/static-files-microservice

Micro-service to save and get the archives with the languages templates, teachers' tests and students' submissions 📁
https://github.com/upb-code-labs/static-files-microservice

golang micro-service mvc mvc-architecture rest rest-api static-files

Last synced: 2 months ago
JSON representation

Micro-service to save and get the archives with the languages templates, teachers' tests and students' submissions 📁

• Host: GitHub
• URL: https://github.com/upb-code-labs/static-files-microservice
• Owner: upb-code-labs
• License: agpl-3.0
• Created: 2023-11-22T15:15:41.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-30T02:05:24.000Z (about 2 years ago)
• Last Synced: 2024-06-21T19:48:53.854Z (almost 2 years ago)
• Topics: golang, micro-service, mvc, mvc-architecture, rest, rest-api, static-files
• Language: Go
• Homepage:
• Size: 129 KB
• Stars: 3
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/contributing.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# Static Files Micro-service

Welcome to the static files micro-service. This service is responsible for storing and serving the following `.zip` archives: 

- `Templates`: Programming language templates we provide to teachers to write their own tests and to students to write their own solutions.

- `Tests`: Tests written by teachers to evaluate the students' solutions.

- `Submissions`: Students' solutions to the tests.

Below is a diagram of the overall architecture of the system with the Static Files micro-service highlighted in green.

![Static Files microservice highlighted with a green rectangle in the overall architecture diagram](./docs/images/static-files-microservice-highlighted.png)

## Documentation

Please, refer to the following documents for more information about the Static Files micro-service:

| Document | Description |

| --- | --- |

| [Contributing](./docs/contributing.md) | Contributing guidelines. |

| [Environment](./docs/environment.md) | A description of the environment variables used by the micro-service. |

| [Insomnia Collection](./docs/http/Insomnia.json) | An [Insomnia](https://insomnia.rest/) collection with the REST endpoints of the micro-service. |

| [OpenAPI Specification](./docs/openapi/spec.yaml) | An [OpenAPI](https://swagger.io/specification/) specification with the REST endpoints of the micro-service. |