WASAPhoto

Description

WASAPhoto is a social networking web application focused on photo sharing, similar to Instagram. Built with modern web technologies, WASAPhoto allows users to upload images and interact with other users through comments, likes, follows and other.

Project structure

• cmd/ contains all executables; Go programs here should only do "executable-stuff", like reading options from the CLI/env, etc.
  • cmd/healthcheck is an example of a daemon for checking the health of servers daemons; useful when the hypervisor is not providing HTTP readiness/liveness probes (e.g., Docker engine)
  • cmd/webapi contains an example of a web API server daemon
• demo/ contains a demo config file
• doc/ contains the documentation (usually, for APIs, this means an OpenAPI file)
• service/ has all packages for implementing project-specific functionalities
  • service/api contains an example of an API server
  • service/globaltime contains a wrapper package for time.Time (useful in unit testing)
• vendor/ is managed by Go, and contains a copy of all dependencies
• webui/ is an example of a web frontend in Vue.js; it includes:
  • Bootstrap JavaScript framework
  • a customized version of "Bootstrap dashboard" template
  • feather icons as SVG
  • Go code for release embedding

Other project files include:

• open-npm.sh starts a new (temporary) container using node:lts image for safe web frontend development (you don't want to use npm in your system, do you?)

How to build

If you're not using the WebUI, or if you don't want to embed the WebUI into the final executable, then:

go build ./cmd/webapi/

If you're using the WebUI and you want to embed it into the final executable:

./open-npm.sh
# (here you're inside the NPM container)
npm run build-embed
exit
# (outside the NPM container)
go build -tags webui ./cmd/webapi/

How to run (in development mode)

You can launch the backend only using:

go run ./cmd/webapi/

If you want to launch the WebUI, open a new tab and launch:

./open-npm.sh
# (here you're inside the NPM container)
npm run dev

Docker containers

Build docker images:

# Build backend image
docker build -t wasaphoto-backend:latest -f Dockerfile.backend .

# Build frontend image
docker build -t wasaphoto-frontend:latest -f Dockerfile.frontend .

Run docker images:

# Run backend image
docker run -it -p 3000:3000 --rm wasaphoto-backend:latest

# Run frontend image
docker run -it -p 8080:80 --rm wasaphoto-frontend:latest

Known issues

Apple M1 / ARM: failed to load config from...

If you use Apple M1/M2 hardware, or other ARM CPUs, you may encounter an error message saying that esbuild (or some other tool) has been built for another platform.

If so, you can fix issuing these commands only the first time:

./open-npm.sh
# (here you're inside the NPM container)
npm install
exit
# Now you can continue as indicated in "How to build/run"

To-do

• Add Docker Compose to manage backend and frontend services.

Basic structure

See Fantastic Coffee (decaffeinated)

License

See LICENSE.