SnapShot Exchange

The project is available online at https://snapshotexchange.onrender.com/views/dashboard

Table of contents

• Using Technologies
• Description
• Project Installation
  • Local Installation
  • DockerHub
• Implementation
  • API routes
  • Server side rendering
  • Chat
• Information for Developers
• License
  • MIT License

Using Technologies

Description

Our app allows users to upload, edit and delete their photos, as well as interact with each other by commenting and rating photos. Users also have the ability to create unique QR codes for their photos and share them with other community members, making photo sharing even more convenient and fun. They can also chat and discuss each other's photos and share the experience of processing photos with the help of Cloudynary service.

Project Installation

Local Installation

To manage project dependencies, pipenv is used.

• Make sure you have pipenv installed

• Clone the repository git clone https://github.com/sergiokapone/SnapshotExchange.git

• To install the dependencies, use the pipenv install or pipenv sync command.

Detailed steps in your terminal a following:

git clone https://github.com/sergiokapone/SnapshotExchange.git
cd SnapshotExchange
pipenv install
python main.py

DockerHub

Our project can also be found at DockerHub. To launch the application, you can use the command:

docker run -p 8000:8000 sergiokapone/snapshopexchange

Implementation

Once the application is running locally, you can browse to run it on your local host using the following links:

• To view detailed information on our project http://localhost:8000/views/info

• To view detailed information on our project in JSON format http://localhost:8000/

• To test the connection to the database and server time information http://localhost:8000/api/healthchecker

For comfortable viewing of JSON respone in your browser we recommend to install the extension for Google Chrome JSON Viewer or JSON Formatter (according to your taste)

Admin Dashboard

We also tried to implement an Admin Dashboard for our application to conveniently manage and control its content, settings and users.

• The Admin Dashboard is available at http://localhost:8000/views/dashboard

API routes

The main goal of application is primarily designed to implement a REST API, which plays a key role in ensuring efficient interaction between frontend developers (React, View, Angular) and our service.

All documentation on interacting with our API is available at the following links:

• To view swagger documentation http://localhost:8000/docs

• To view redoc documentation http://localhost:8000/redoc

Chat

Also our app is equipped with a chat for short messaging via websocket. The chat is available at the link:

• http://localhost:8000/views/chat

Information for Developers

Our project is equipped with Sphinx documentation, which you can find at https://sergiokapone.github.io/SnapshotExchange/. The documentation may be useful to other developers who can use it to develop our project.

License

This project is licensed under the terms of the MIT License.

MIT License

Copyright © [FastTrack Codes]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.