Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cloudinary-community/photocrate
Photo library and interactive editor built with Next.js & Cloudinary
https://github.com/cloudinary-community/photocrate
Last synced: 3 days ago
JSON representation
Photo library and interactive editor built with Next.js & Cloudinary
- Host: GitHub
- URL: https://github.com/cloudinary-community/photocrate
- Owner: cloudinary-community
- License: mit
- Created: 2024-01-31T13:15:22.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-06-25T16:02:20.000Z (5 months ago)
- Last Synced: 2024-11-07T12:44:58.423Z (6 days ago)
- Language: TypeScript
- Homepage: https://www.photobox.dev/
- Size: 388 KB
- Stars: 131
- Watchers: 3
- Forks: 15
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📷 PhotoCrate
[](#contributors-)
Google Photos clone for building a dynamic image gallery with Cloudinary.
Features include:
* Gallery view of all PhotoCrate-uploaded images
* Image viewer with AI-powered editing
* Filters and Effects
* Creations including Collages, Animations, & Color Pop
* Media Management
## What's Inside
Technology used to build PhotoCrate includes:
* Next.js App Router
* React Server Components for initial resource queries
* Suspense loading states
* Styling with Tailwind CSS
* Components using shadcn/ui
* Request management with Tanstack React Query
* Cloudinary for image storage, optimization, and transformation
## 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!
2. Create a .env.local file or configure your environment variables to include:
```
NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME=""
NEXT_PUBLIC_CLOUDINARY_API_KEY=""
CLOUDINARY_API_SECRET=""
```
3. 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:
```jsx
const config = {
title: 'PhotoCrate'
logo: ,
};
```
You can configure these values inside of the `theme.config.tsx` file as needed:
```jsx
const config = {
title: ''
logo: ,
}
```
### 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:
```jsx
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:
```jsx
const config = {
assetsFolder: '';
assetsTag: '';
libraryTag: '';
creationTag: '';
favoritesTag: '';
trashTag: '';
}
```
Using environment variables, configure the following as needed:
```shell
NEXT_PUBLIC_CLOUDINARY_ASSETS_FOLDER=""
NEXT_PUBLIC_CLOUDINARY_ASSETS_TAG=""
NEXT_PUBLIC_CLOUDINARY_LIBRARY_TAG=""
NEXT_PUBLIC_CLOUDINARY_CREATION_TAG=""
NEXT_PUBLIC_CLOUDINARY_FAVORITES_TAG=""
NEXT_PUBLIC_CLOUDINARY_TRASH_TAG=""
```
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Colby Fayock
💻 📖
Nick Taylor
💻
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!