PhotoBox

This project is for raspberry but you can also use it on all nodeJS servers. You can have a slideshow of your event, you can upload file to add in your slideshow, users can also send comments, they will be visible in the slideshow.

📋 Features

🏠 Home Page

On the home page, you can upload an image file (.jpeg, .jpg, .png, gif, .svg, .bmp) by clicking on "Choose an image".

You can also, go to the add comment page by clicking on "send a comment".

🎬 SlideShow Page

You can access to this page with the URL : "/slideshow".

On this page, you can see a slideshow with all images uploaded. You can see also user's comments at the bottom of this page (image 2).

💬 Add comment Page

You can access to this page with the URL : "/addComment" or with the home page.

On this page, you can send a comment. You have to write your username and your message. To send it click on "send the comment".

🔒 Admin Page

You can access to this page with the URL : "/admin". You have to write the admin key to access to this page.

On this page, you can see many data, number of users connected, the list of comments sent, the list of remove files from the slideshow and the list of visible files in the slideshow.

For each uploaded file, you can remove it from the slideshow by clicking on "Remove from the slideshow", it will be not visible after. For each removed file from the slideshow, you can add it in the slideshow by clicking "add to slideshow", it will be visible after.

🚀 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

📐 Prerequisites

You need to download NodeJS if you don't have it.

You need to clone this repo, run :

git clone "https://github.com/alexisgauvrit/PhotoBox.git"

🔧 Installing

Run command :

npm install

After that, you need to create a config.json file (./PhotoBox/config.json) like that (you have to complete with your data) :

{
    "port" : "CUSTOM_PORT",
    "upload_path" : "FAKE/PATH/",
    "deleted_path" : "FAKE/PATH/2/",
    "application_name" : "PhotoBox",
    "admin_key" : "CUSTOM_ADMIN_KEY"
}

• "port" : is the port witch listen nodeJS for this application.
• "upload_path" : is the path which is use to store upload files (need "/" at the end (linux) / need "\" at the end (Windows)).
• "deleted_path" : is the path which is use to store deleted files (need "/" at the end (linux) / need "\" at the end (Windows)).
• "application_name" : is the name of the application which is use by all pages of the application.
• "admin_key" : is the key use to access to admin panel.

🤘 Deployment

You have to create a reverse proxy to redirect your 80 port to your custom port.

I recommand you this tutorial : How To Serve Node.js Applications with Nginx.

Now you can enjoy it.

🔨 Built With

• NodeJS
• NPM
• Express

📂 Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

🤝 Authors

• 👤 Alexis Gauvrit - Initial work - alexisgauvrit

See also the list of contributors who participated in this project.

🏆 License

This project is licensed under the MIT License - see the LICENSE.md file for details