Lychee

Abstract

1. Introduction

[![GitHub Release][release-shield]](https://github.com/LycheeOrg/Lychee/releases) [![PHP 8.4 & 8.5][php-shield]](https://lycheeorg.dev/docs/#server-requirements) [![MIT License][license-shield]](https://github.com/LycheeOrg/Lychee/blob/master/LICENSE) [![Downloads][download-shield]](https://github.com/LycheeOrg/Lychee/releases) [![Build Status][build-status-shield]](https://github.com/LycheeOrg/Lychee/actions) [![Code Coverage][codecov-shield]](https://codecov.io/gh/LycheeOrg/Lychee) [![CII Best Practices Summary][cii-shield]](https://bestpractices.coreinfrastructure.org/projects/2855) [![OpenSSF Scorecard][ossf-shield]](https://securityscorecards.dev/viewer/?uri=github.com/LycheeOrg/Lychee) [![Website][website-shield]](https://lycheeorg.dev) [![Documentation][docs-shield]](https://lycheeorg.dev/docs/) [![Changelog][changelog-shield]](https://lycheeorg.dev/docs/getting-started/releases/) [![Discord][discord-shield]][discord] [](https://gitgem.org/github/LycheeOrg/Lychee)

Lychee is a free, open-source photo-management tool that runs on your server or web space. Installation is quick and easy, taking just seconds. With Lychee, you can upload, manage, and share your photos seamlessly, just like using a native application. It comes with all the essential features you need, ensuring your photos are stored securely. Read more on our website.

Through contributions, donations, and sponsorship, you allow Lychee to thrive. Your donations directly support demo server costs, continuous enhancements, and most importantly bug fixes!

2. Objective

A great looking and easy-to-use photo-management-system you can run on your server, to manage and share photos.

This project demonstrates how PHP, TypeScript, Vue.js can be applied to a real-world Full Stack Web Development problem.

4. Technology Stack

5. System Requirements

General requirements for this technology stack — check the README for exact versions.

• PHP 7.4+ with a web server (XAMPP / WAMP / LAMP)
• MySQL / MariaDB
• phpMyAdmin (optional)
• Node.js (LTS) and npm / yarn / pnpm
• VS Code or any code editor
• Git (to clone the repository)

6. Installation & Setup

git clone https://github.com/LycheeOrg/Lychee.git
cd Lychee

1. Pre-built releases: Download from GitHub Releases
2. From source: Requires PHP 8.4+, Composer, and npm

Full setup instructions are in the project README.

7. Future Enhancements

Suggested extensions you can add to make this your own project.

• Add role-based access control
• Deploy on a VPS or cPanel hosting with a custom domain
• Add automated tests and a CI pipeline

8. Viva / Review Questions

Common questions examiners ask for projects in this domain.

1. Explain the frontend, backend and database layers of this application.
2. How is user authentication and authorisation implemented?
3. Describe the main database tables / collections and their relationships.
4. Which REST APIs or routes are exposed and what do they return?
5. How would you deploy this application to production?

9. Source Code & License

This project is developed by LycheeOrg and published on GitHub under the MIT License. Please follow the license terms and credit the original author when you use or modify this code.