ShutterSync

ShutterSync aims to address the need for professional photographers to efficiently share and collaborate on their work with clients, enhancing client engagement and project management.

Documentation

Documentation

Documentation & Testing You will need an API_KEY for production server.

Features

• Lightweight image assets for display and you get to keep your original files
• Light/dark mode toggle
• Responsive design
• User authentication
• User authorization
• User profile management
• Album management
• Photo management
• Photo sharing

Tech Stack

Client: React, TypeScript, Chakra UI, Framermotion

Server: Node, Express, JavaScript, MongoDB, Cloudinary, Multer

Testing: Jest, React Testing Library, Supertest

Deployment: Heroku, Google Cloud Platform, Vercel

Installation

Run locally. Git clone first.

  npm install ShutterSync
  cd ShutterSync

You will need a Mongo DB setup if you want to run it with your DB.

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

API_KEY DB_URI DB_URI PORT CLOUDINARY_API_KEY MAIL_HOST MAIL_PORT MAIL_USER MAIL_PWD MAIL_DOMAIN GOOGLE_PROJECT_ID GOOGLE_PRIVATE_KEY_ID GOOGLE_PRIVATE_KEY GOOGLE_CLIENT_EMAIL

CI Tests

API References

Include a 'x-api-key' header with your API_KEY in all requests

Sign up

  POST /api/auth/signup

Sign in

  POST /api/auth/signin

Sign out

  GET /api/auth/signout

Get user

  GET /api/users/${id}

Update user

  PUT /api/users/${id}

Delete user

  DELETE /api/users/${id}

Create an album

  POST /api/users/${userid}/albums

Get an album

  GET /api/users/${userid}/albums/${albumid}

Update an album

  PUT /api/users/${userid}/albums/${albumid}

Delete an album

  DELETE /api/users/${userid}/albums/${albumid}

Get all albums

  GET /api/users/${userid}/albums

Create a photo

  POST /api/users/${userid}/albums/${albumid}/photo

Get a photo

  GET /api/photos/${photoid}

Update a photo

  PUT /api/photos/${photoid}

Delete a photo

  DELETE /api/photos/${photoid}

Get all photos

  GET /api/users/${userid}/albums/${albumid}/photos

Authors

• Siaw A. Nicholas