ModelVault

Report a Bug · Request a Feature . Ask a Question

Table of Contents

• About
  • Built With
• Getting Started
  • Prerequisites
  • Installation

• Roadmap
• Support
• Project assistance
• Contributing
• Authors & contributors
• Security
• License

---

About

[!] This project is under active development. This means the codebase is subject to frequent changes, and features may be unstable or incomplete. While we welcome contributions and feedback, please be aware that things might break unexpectedly. This project is in its early stages and provides a basic solution for organizing and managing your 3D model collection. Current features include: Easy model uploading and storage Simple tagging functionality

Built With

Getting Started

Prerequisites

• Python 3.11
• Node v21.6.2
• NPM 10.2.4

Installation (locally)

Backend

cd backend
uvicorn main:app [--reload]

Frontend

cd frontend
npm run dev

Installation (local Docker)

Backend

cd backend
docker build -t modelvault-backend:latest .
docker run -d -p 8000:8000 modelvault-backend:latest

Frontend

cd frontend
docker build -t modelvault-frontend:latest .
docker run -d -p 3000:3000 modelvault-frontend:latest

Roadmap

See the open issues for a list of proposed features (and known issues).

• Top Feature Requests (Add your votes using the 👍 reaction)
• Top Bugs (Add your votes using the 👍 reaction)
• Newest Bugs

Support

Reach out to the maintainer at one of the following places:

• GitHub issues
• Contact options listed on this GitHub profile

Project assistance

If you want to say thank you or/and support active development of ModelVault:

• Add a GitHub Star to the project.
• Tweet about the ModelVault.
• Write interesting articles about the project on Dev.to, Medium or your personal blog.

Together, we can make ModelVault better!

Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

Authors & contributors

The original setup of this repository is by Remco Goyvaerts.

For a full list of all authors and contributors, see the contributors page.

Security

ModelVault follows good practices of security, but 100% security cannot be assured. ModelVault is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

License

This project is licensed under the MIT license.

See LICENSE for more information.