Skip to content

Online album to share, categorize and map your images!

License

Notifications You must be signed in to change notification settings

Workata/photo-album

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Photo album

WIP - Work in progress


Logo

Photo album

Online album to share, categorize and map your images!


View Demo · Report Bug · Request Feature

Table of Contents TODO
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

Online album to share, categorize and map your images!

Built With

Frontend

Backend

Deploy

Getting Started

I used Ubuntu 20.04 - WSL

Prerequisites

General

  1. Generate Google reCAPTCHA keys (reCAPTCHA v2 - invisible)
  • site key
  • secret key
  1. Generate secret key for JWT:
    openssl rand -base64 64

Development

Production

 

Installation

Every step is done starting from project root directory

General

  1. Clone the repo

    git clone https://github.com/Workata/photo-album.git
  2. Set API keys - backend

    cd backend
    touch .env
    echo "SECRET_KEY_LOGIN_TOKEN=\"<insert_JWT_key_here>\"" >> .env
    echo "SECRET_KEY_GOOGLE_RECAPTCHA=\"<insert_RECAPTCHA_key_here>\"" >> .env
  3. Set API keys - frontend

    cd frontend
    touch .env
    echo "REACT_APP_RECAPTCHA_SITE_KEY=<insert_RECAPTCHA_site_key_here>" >> .env
  4. Create admin account (use venv with required libs)

    cd backend
    . ./venv/bin/activate
    python ./src/utils/addAdmin.py <username> <password>

Development

  1. Create python venv - only once
    cd backend
    python3 -m venv ./venv
  2. Install python libs - only once
    cd backend
    . ./venv/bin/activate
    pip install -r requirements.txt
  3. Install npm packages - only once
    cd frontend
    npm install
  4. Run backend
    cd backend
    . ./venv/bin/activate
    uvicorn src.main:app --reload
  5. Run frontend
    cd frontend
    npm start

Production

  1. Change domain name in a Caddyfile

  2. Build images using Docker Compose

    sudo docker-compose build
  3. Start containers

    sudo docker-compose up

Usage

TODO

Roadmap

TODO

Contributing

Me, lmao

License

Distributed under the MIT License. See LICENSE for more information.

Contact & Info

Mail: workatagit@gmail.com

Project source: https://github.com/Workata/photo-album

Project website: TomTol

Acknowledgments

(back to the top)

About

Online album to share, categorize and map your images!

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published