paperarium / paperarium-designer Goto Github PK

View Code? Open in Web Editor NEW

An open source Qt and Vulkan-based desktop application for unfolding 3D models into papercrafts.

License: GNU Lesser General Public License v2.1

CMake 3.52% C++ 93.86% C 0.18% GLSL 2.14% Shell 0.30%

paperarium-designer's Introduction

Paperarium

A modern compendium for papercrafting.

Key Features • How To Use • Credits • Related • License

Key Features

Papercrafts
- Designs with PDFs (for lined and lineless) and an optional PDO
- [FUTURE] Likes and comments on papercrafts, independent from traditional Blogger
Builds
- Images and descriptions with image files of user-submitted builds of papercrafts
- [FUTURE] Likes and comments on builds, independent from traditional Blogger
Profiles
- User information, including websites, bios, and statistics about uploaded crafts
- [FUTURE] Followers, with user feed of followed crafts
Collectives
- Groups of users, and papercrafts created under a collective's name (i.e. PaperPokés, PaperZelda)
- [FUTURE] Followers, with user feed of followed crafts
Papercraft tags for filtering
Masonry grid view of papercrafts
SEO optimization and super-fast loading
Backend image optimization
PhpBB forum in Nintendo Papercraft style
Admin pane for management
[FUTURE] In-browser model view using GLBs

How To Use

To clone and run the website locally, you'll need Git, Node.js, and Yarn installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/paperarium/paperarium

# Go into the repository
$ cd paperarium

# Install dependencies
$ yarn install

# Run the app
$ yarn dev

Note You'll also need the Supabase API keys in a .env.local file in the root directory. Contact Evan if you don't have them.

Community

Paperarium operates as a website, a forum, and a discord channel. If you have access to this git repository, you're probably already in some combination of these. But make sure you have an account on the website! The more users we have, the better :)