marcorealacci/WASAPhoto
1
0
Fork 0
mirror of https://github.com/notherealmarco/WASAPhoto.git synced 2025-03-13 05:29:09 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Remove stuff for the exam grader && improve README

Browse source
This commit is contained in:
Marco Realacci 2023-01-25 19:00:04 +01:00
parent 0090df033f
commit 6f74aaeaaf
4 changed files with 54 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Dockerfile.backend
View file

@ -19,4 +19,4 @@ WORKDIR /app/
COPY --from=builder /app/webapi ./
### Executable command
CMD ["/app/webapi"]
CMD ["/app/webapi", "--db-filename", "/data/wasaphoto.db", "--data-path", "/data/data"]

51
README.md
View file

@ -19,7 +19,56 @@ This is my project for the Web And Software Architecture (WASA) class
* An API specification using the OpenAPI standard
* A backend written in the Go language
* A frontend in Vue.js
* Dockerfiles to deploy the backend and the frontend in a contaner.
* Dockerfiles to deploy the backend and the frontend in containers.
* Dockerfile.backend builds the container for the backend
* Dockerfile.frontend builds the container for the frontend
* Dockerfile.embedded builds the backend container, but the backend's webserver also delivers the frontend
### Before building
If you're building the project in production mode (see below), you need to specify the base URL for the backend in `vite.config.js`.
## Build & deploy
The only (officially) supported method is via Docker containers.
There are two supported methods.
#### Embedded build
This method is only recommended for testing purposes or instances with very few users (for performance reasons).
The following commands will build a single container to serve both frontend and backend.
```
docker build -t wasaphoto -f Dockerfile.embedded .
docker run -p 3000:3000 -v <path to data directory>:/data --name wasaphoto wasaphoto
```
Everything will be up and running on port 3000 (including the Web UI).
#### Production build
This method build two containers, one for the backend and a container that running nginx to serve the frontend.
This is very recommended on production envinoments.
1. Build and run the backend
```
docker build -t wasabackend -f Dockerfile.backend .
docker run -p 3000:3000 -v <path to data directory>:/data --name wasaphoto-backend wasabackend
```
2. Edit the `vite.config.js` file and replace `<your API URL>` with the backend's base URL.
3. Build and run the frontend
```
docker build -t wasafrontend -f Dockerfile.frontend .
docker run -p 8080:80 --name wasaphoto-frontend wasafrontend
```
The Web UI will be up and running on port 8080!
<your API URL>

3
webui/package.json
View file

@ -3,11 +3,10 @@
"version": "0.0.0",
"scripts": {
"dev": "vite",
"dev-backend": "vite --mode development-backend",
"dev-extern-backend": "vite --mode developement-external",
"build-dev": "vite build --mode development",
"build-prod": "vite build --mode production",
"build-embed": "vite build --mode production --base=/dashboard/",
"build-embed-host": "vite build --mode embedded --base=/dashboard/",
"preview": "vite preview --port 4173"
},
"dependencies": {

8
webui/vite.config.js
View file

@ -13,7 +13,7 @@ export default defineConfig(({command, mode, ssrBuild}) => {
}
},
};
if (command === 'serve' && mode !== 'development-backend') {
if (command === 'serve' && mode !== 'developement-external') {
ret.define = {
"__API_URL__": JSON.stringify("http://localhost:3000"),
};
@ -21,13 +21,9 @@ export default defineConfig(({command, mode, ssrBuild}) => {
ret.define = {
"__API_URL__": JSON.stringify("/"),
};
} else if (mode === 'development-backend') {
ret.define = {
"__API_URL__": JSON.stringify("https://wasaphoto.marcorealacci.me"),
};
} else {
ret.define = {
"__API_URL__": JSON.stringify("http://localhost:3000"),
"__API_URL__": JSON.stringify("<your API URL>"),
};
}
return ret;