https://github.com/bryopsida/object-store

A REST api for storing objects using Node.JS and Fastify
https://github.com/bryopsida/object-store

fastify nodejs object-storage rest-api wip

Last synced: 3 months ago
JSON representation

A REST api for storing objects using Node.JS and Fastify

• Host: GitHub
• URL: https://github.com/bryopsida/object-store
• Owner: bryopsida
• License: unlicense
• Created: 2022-06-10T02:44:08.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-18T16:19:04.000Z (4 months ago)
• Last Synced: 2024-10-11T23:11:04.042Z (3 months ago)
• Topics: fastify, nodejs, object-storage, rest-api, wip
• Language: TypeScript
• Homepage:
• Size: 1.49 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Object-Store

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=bryopsida_object-store&metric=coverage)](https://sonarcloud.io/summary/new_code?id=bryopsida_object-store) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=bryopsida_object-store&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=bryopsida_object-store) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=bryopsida_object-store&metric=bugs)](https://sonarcloud.io/summary/new_code?id=bryopsida_object-store) [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=bryopsida_object-store&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=bryopsida_object-store)

This is a simple service that stores objects on the local filesystem.

## How to get started

You can run this application either directly with node or using a container. The default storage area uses the temp folder for your operating system, you should customize this to an area more appropriate for your system.

### NPM

This application is compatible with node versions 16-20, you can install the application with `npm install -g @bryopsida/object-store`, and run it with `object-store`. The default credentials are `admin:admin` and you can find more information about the API at the swagger ui at http://localhost:3000/documentation.

### Docker

A docker image is provided if you prefer to use a container. You can run the application using `docker run ghcr.io/bryopsida/object-store:main -p 8080:8080`, the default credentials are `admin:admin` and you can find more information about the API at http://localhost:8080/documentation/.

## Work in progress

This is currently a work in progress, for more information on what's done and what's coming up checkout the [project](https://github.com/users/bryopsida/projects/2/views/2)