README.md

Share my photos

A web application to publish your photos and create a real-time slideshow synchronized on multiple devices.


View Demo on YouTube

Table of Contents

1. About The Project
   • Required specifications
   • Bonus specifications
2. Built with
   • Front-end
   • Back-end
3. Architecture diagram
4. Database diagram
5. Screenshots
6. Contributing
7. License

About The Project

This school project is made by Florian Zdrada and Kamil Caglar.

Required specifications

• Add one or multiple photos with a description
• Photo modification
• Photo deletion
• Real-time slideshow across multiple devices
• Search for photo

Bonus specifications

• Register / login
• Organisations, albums (create, update, delete)
• Access managements to organisations
• Comments on photos
• Tags on photos
• Real-time comments on slideshow
• PWA application
• Auto-deployment on DigitalOcean from GitHub with high-availability and HTTPS

Built With

Front-end

Client

• Vue.js
• Nuxt.js
• Vuetify

Back-end

Server

• AdonisJS
• Socket.IO

Storage

• PostgreSQL
• MinIO

Deployment

• Docker
• DigitalOcean

Architecture diagram

Database diagram

Screenshots

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

License

Distributed under the MIT License.