https://github.com/sleepyminer/imageserver
PhotoCloud - A image server to host and upload images.
https://github.com/sleepyminer/imageserver
bun pocketbase sveltekit typescript
Last synced: about 2 months ago
JSON representation
PhotoCloud - A image server to host and upload images.
- Host: GitHub
- URL: https://github.com/sleepyminer/imageserver
- Owner: SleepyMiner
- License: mit
- Created: 2024-12-29T15:44:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-10T08:36:58.000Z (over 1 year ago)
- Last Synced: 2025-02-25T14:51:28.549Z (over 1 year ago)
- Topics: bun, pocketbase, sveltekit, typescript
- Language: Svelte
- Homepage: https://sleepyminer.github.io/ImageServer/
- Size: 16.2 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PhotoCloud
PhotoCloud is a modern, lightweight application built using **SvelteKit** and **PocketBase**. It allows users to upload, manage, and search for images. Users can also update their profiles, view their uploaded images, and manage their account with ease.
## Features
- **User Authentication**
- Register and log in with a secure and seamless flow.
- Update profile information.
- **Image Management**
- Upload images to the platform.
- View your uploaded images in a user-friendly interface.
- Search for images based on various filters or keywords.
- Update and delete your uploaded images.
- **Search Capabilities**
- Find images using keywords and filters to locate your favorite content quickly.
- **Modern UI**
- Clean and responsive design with **TailwindCSS** and **DaisyUI** component library.
## TODO
- Add update & delete feature to already uploaded images to their respective users.
- Add feature to favourite images.
- Add forget password function.
## Tech Stack
- **SvelteKit**: The framework used for building the frontend with modern, reactive components.
- **PocketBase**: A lightweight backend database solution for handling authentication, data storage, and real-time updates.
- **TailwindCSS**: A utility-first CSS framework for building fast and responsive designs.
- **DaisyUI**: A TailwindCSS-based component library for pre-designed and customizable UI components.
## Installation
To set up PhotoCloud on your local machine, follow these steps:
### Prerequisites
Ensure you have the following installed:
- [Bun](https://bun.sh/)
- [Pocketbase - Windows](https://github.com/pocketbase/pocketbase/releases/download/v0.24.1/pocketbase_0.24.1_windows_amd64.zip)
- [Pocketbase - Linux & Mac](https://github.com/pocketbase/pocketbase/releases/download/v0.24.1/pocketbase_0.24.1_linux_amd64.zip)
- #### For Makefile : [MinGW](https://www.mingw-w64.org/downloads/#winlibscom)
### Steps
1. Clone this repository:
```bash
git clone https://github.com/SleepyMiner/ImageServer.git
cd ImageServer
bun install
```
2. Start the Pocketbase Server (Backend):
1. Make a new folder in the ImageServer directory named **pb** ***(Keep the folder name same as this)***
2. Extract the downloaded zip file
3. Paste the contents in the pb folder
4. Run the following command after
```bash
make server
```
> The Server will start at port - 8090.
> > The Credentials for Admin Dashboard are - \
> > **Username** - test@example.com \
> > **Password** - 1234567890
4. Start the UI (Frontend):
```bash
bun dev
```
> The Svelte application will start at port - 5173
### Contribution Guidelines
#### We welcome contributions! To contribute:
1. Fork the repository.
2. Create a new branch for your feature/bugfix.
3. Submit a pull request with a clear description of the changes.
### License
This project is licensed under the MIT License.
### Acknowledgments
- [SvelteKit Documentation](https://svelte.dev/docs/kit/introduction)
- [PocketBase Documentation](https://pocketbase.io/docs/)
- [TailwindCSS Documentation](https://tailwindcss.com/docs/)
- [DaisyUI Documentation](https://daisyui.com/docs/)