Handover of CSESoc Website 2019 to the Future

`Footer.vue` fetches from a gist to dummy the API

Pull a list of sponsors from the API sponsors/ (replace the gist w/ the actual API URI)

Add GET sponsors/ endpoint

`LoginForm.vue` fetches data from data() as static data

Use the login/ API path (replace the gist w/ the actual API URI)

? (should decide if login is necessary - need to check login code carefully)

Sidebar.vue fetches data from data() as static data

Use categories/ API path, handle icons and routes

Need to update categories to have icons(?) and route (same w/ posts)

ContentPage.vue uses dummy data

Accept data from the API posts/ path, should be a generic page w/ content on it

Use a fetch call

Home.vue uses a variety of dummy data

Use actual API endpoints - you can read the gists to figure out what they vaguely should return

Replace API endpoints;

Go serves static assets and API

static assets are served using a proper file server e.g nginx - you can test using python’s inbuilt http.server

Decouple the HTTP server and the API from each other

Home.vue media slider is broken

Show a gallery of images (intended for social images) but could be anything

because of the dummy data used all the images are now broken - once you use real data it’ll show

public/

Static files used by Vue

Holds wrapper on all Vue views

server/

Go files that serve the web server and the API

server/category.go

Website category code:
A category was intended to be a grouping of posts (i.e. a section in the sidebar)

https://gawdn.com/api-docs/

server/go.mod

File that stores Go modules

https://blog.golang.org/using-go-modules

server/go.sum

Auto-generated lock file for Go modules

https://blog.golang.org/using-go-modules

server/login.go

Log into the website using LDAP authentication (UNSW zID login) - avoiding rolling own auth (never properly established if this was necessary beyond admins logging in) - potential use for merch? voting?

https://www.tldp.org/HOWTO/LDAP-HOWTO/whatisldap.html

server/post.go

Everything is a post:

Events are posts
”Content” pages are posts etc.

Groups of posts have different “views” avaliable to them e.g. viewing as a list, as a grid etc.

Posts can appear in menus under their respective category (section)

https://gawdn.com/api-docs/

server/server.go

Serves /dist/ (frontend) and the API

Can serve the frontend and API (connecting to the MongoDB database) including static assets

At the moment API isn’t prefixed (it really should be i.e. /api/v1/post instead of /post

Holds the API calls themselves i.e. handling the query parameters which calls to the modules - it was intentionally designed this way to keep the server-level cohesive - and decoupled from the underlying DB logic

server/sponsor.go

Handles sponsor related database code

https://gawdn.com/api-docs/

services/

Holds the Dockerfiles for the project

Incomplete, doesn’t actually build the project

src/assets/

Holds static assets

src/components

Holds Vue components (reusable parts)

ListComponent
Slider
NavGrid

are all ways to show posts

.eslintrc.js

Provides linting to the Vue side of the project - would highly recommend setting up your IDE to automatically run the linter as you go

CONTRIBUTING.md

The branch structure we used