cloudinary-community / photocrate

Photo library and interactive editor built with Next.js & Cloudinary
https://www.photobox.dev/
MIT License
123 stars 14 forks source link

📷 PhotoCrate

All Contributors

Google Photos clone for building a dynamic image gallery with Cloudinary.

Features include:

What's Inside

Technology used to build PhotoCrate includes:

Getting Started

  1. Create a new local project
npx create-next-app@latest -e https://github.com/cloudinary-community/photocrate photocrate

You can also fork or clone the project manually!

  1. Create a .env.local file or configure your environment variables to include:
NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME="<Your Cloud Name>"
NEXT_PUBLIC_CLOUDINARY_API_KEY="<Your API Key>"
CLOUDINARY_API_SECRET="<Your API Secret>"
  1. Install dependencies and start the project.
npm install
npm run dev

And you should now be running PhotoCrate at http://localhost:3000/!

Using PhotoCrate

To start using PhotoCrate, simply upload some images! The Upload button can be found on the top right of the library page.

After uploading, the image should now show up in your gallery where you can either start adding Creations from your image or edit it by navigating to a particular image.

PhotoCrate takes advantage of both folders and tags to organize the images in your Cloudinary account. By default, all images are uploaded to a "photocrate" folder and tagged with "photocrate" and other tags prepended with "photocrate-". This makes it easy to keep track of what images should be included in PhotoCrate without cluttering your existing account.

Configuration

PhotoCrate ships with some default configurations to help you get started, but is customizable based on your needs or preferences.

Customization

To personalize your PhotoCrate without manually updating the code, a few options are made available for configuration.

The default values used for these are:

const config = {
  title: 'PhotoCrate'
  logo: <Focus className="w-6 h-6" />,
};

You can configure these values inside of the theme.config.tsx file as needed:

const config = {
  title: '<Your Title>'
  logo: <YourLogo />,
}

Asset Organization

Tags and folders are used to organize assets which are displayed in the app and also used for functional needs like providing Favorites and Trash capabilities.

The default values used for these are:

const config = {
  assetsFolder:  'photocrate',
  assetsTag: 'photocrate',
  libraryTag: 'photocrate-library',
  creationTag: 'photocrate-creation',
  favoritesTag: 'photocrate-favorite',
  trashTag: 'photocrate-trash',
};

There are two ways that you can configure these values, by using the theme.config.tsx file or by configuring environment variables.

Using theme.config.tsx, add the following properties as needed:

const config = {
  assetsFolder: '<Your Folder>';
  assetsTag: '<Your Tag>';
  libraryTag: '<Your Tag>';
  creationTag: '<Your Tag>';
  favoritesTag: '<Your Tag>';
  trashTag: '<Your Tag>';
}

Using environment variables, configure the following as needed:

NEXT_PUBLIC_CLOUDINARY_ASSETS_FOLDER="<Your Folder>"
NEXT_PUBLIC_CLOUDINARY_ASSETS_TAG="<Your Tag>"
NEXT_PUBLIC_CLOUDINARY_LIBRARY_TAG="<Your Tag>"
NEXT_PUBLIC_CLOUDINARY_CREATION_TAG="<Your Tag>"
NEXT_PUBLIC_CLOUDINARY_FAVORITES_TAG="<Your Tag>"
NEXT_PUBLIC_CLOUDINARY_TRASH_TAG="<Your Tag>"

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Colby Fayock
Colby Fayock

💻 📖
Nick Taylor
Nick Taylor

💻

This project follows the all-contributors specification. Contributions of any kind welcome!