CollectionBuddy

A web-app catalog for your collected items 🗂️

Motivation

This project was created to provide a simple and elegant solution for cataloging personal collections. Whether it's stamps, coins, or any other collectible, CollectionBuddy helps you keep track of your items in an organized manner.

Usage

Development

To run the application in a development environment, follow these steps:

1. Navigate to the web directory:

   cd web

2. Install the dependencies:

   npm install

3. Start the development server:

   npm run dev

   The application will be available at http://localhost:3000.

Building for Production

To build the application for production, run the build.sh script from the root directory:

./build.sh

Note: A production build requires the NEXT_PUBLIC_SUPABASE_URL and NEXT_PUBLIC_SUPABASE_ANON_KEY environment variables to be set. These can be obtained from your Supabase project dashboard.

The static files will be generated locally, ready for deployment. The script demonstrates how it's done, but real deployment should happen in your pipeline.

Technology Stack

Frontend

• Next.js: A React framework for building server-side rendered and static web applications.
• React: A JavaScript library for building user interfaces.
• TypeScript: A typed superset of JavaScript that compiles to plain JavaScript.
• Tailwind CSS: A utility-first CSS framework for rapidly building custom designs.
• Framer Motion: A React library for creating animations.

Backend

• Supabase: An open-source Firebase alternative that provides a suite of tools for building applications, including:
  • Authentication: For managing user sign-ups and logins.
  • PostgreSQL Database: For storing application data.
  • Storage: For managing user-uploaded files, such as images of collected items.

Deployment

The application is built as a static site and can be deployed on any static hosting service, such as GitHub Pages, Vercel, or Netlify. The build.sh script prepares the application for deployment.

Technology Map

Contributing

Contributions are welcome! Whether it's a bug fix, new feature, or just improving the docs—open an issue or submit a pull request.

Before contributing, please check out our Contributing Guide.

License

This project is licensed under the MIT License.