https://github.com/scanoss/components
SCANOSS Components API Service
https://github.com/scanoss/components
Last synced: 5 months ago
JSON representation
SCANOSS Components API Service
- Host: GitHub
- URL: https://github.com/scanoss/components
- Owner: scanoss
- License: gpl-2.0
- Created: 2022-06-01T08:38:22.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-09-16T17:46:11.000Z (9 months ago)
- Last Synced: 2025-09-16T20:09:09.541Z (9 months ago)
- Language: Go
- Homepage:
- Size: 9 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# SCANOSS Platform 2.0 Components
Welcome to the component server for SCANOSS Platform 2.0
**Warning** Work In Progress **Warning**
## Repository Structure
This repository is made up of the following components:
* ?
## Configuration
Environmental variables are fed in this order:
dot-env --> env.json --> Actual Environment Variable
These are the supported configuration arguments:
```
APP_NAME="SCANOSS Component Server"
APP_PORT=50051
APP_MODE=dev
APP_DEBUG=false
DB_DRIVER=postgres
DB_HOST=localhost
DB_USER=scanoss
DB_PASSWD=
DB_SCHEMA=scanoss
DB_SSL_MODE=disable
DB_DSN=
```
## Docker Environment
The component server can be deployed as a Docker container.
Adjust configurations by updating an .env file in the root of this repository.
### How to build
You can build your own image of the SCANOSS Component Server with the ```docker build``` command as follows.
```bash
make ghcr_build
```
### How to run
Run the SCANOSS Component Server Docker image by specifying the environmental file to be used with the ```--env-file``` argument.
You may also need to expose the ```APP_PORT``` on a given ```interface:port``` with the ```-p``` argument.
```bash
docker run -it -v "$(pwd)":"$(pwd)" -p 50051:50051 ghcr.io/scanoss/scanoss-components -json-config $(pwd)/config/app-config-docker-local-dev.json -debug
```
## Development
To run locally on your desktop, please use the following command:
```shell
go run cmd/server/main.go -json-config config/app-config-dev.json -debug
```