https://github.com/digitalinteraction/catalyst-webapp
A Vue web app for browsing, searching and viewing Not-Equal Catalyst projects
https://github.com/digitalinteraction/catalyst-webapp
Last synced: about 1 year ago
JSON representation
A Vue web app for browsing, searching and viewing Not-Equal Catalyst projects
- Host: GitHub
- URL: https://github.com/digitalinteraction/catalyst-webapp
- Owner: digitalinteraction
- License: mit
- Created: 2019-03-05T16:50:00.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2021-08-31T12:36:09.000Z (almost 5 years ago)
- Last Synced: 2025-02-09T22:11:19.952Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://catalyst.not-equal.tech/
- Size: 2.48 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Catalyst | Vue WebApp
This is the repo for Not-Equal Catalyst's frontend webapp.
It is a [Vue.js](https://vuejs.org/) project written in JavaScript,
[pug](https://pugjs.org) and [sass](https://sass-lang.com/) and deployed through [Docker](https://www.docker.com/) where it is served using [express](https://expressjs.com/) and [vue-ssr](https://ssr.vuejs.org/).
[What is Not-Equal Catalyst?](https://github.com/unplatform/catalyst-about)
## Table of contents
- [Table of Contents](#table-of-contents)
- [Usage](#usage)
- [Environment variables](#environment-variables)
- [Categorisation file](#categorisation-file)
- [Filters file](#filters-file)
- [Trello key-values](#trello-key-values)
- [Development](#development)
- [Setup](#setup)
- [Regular use](#regular-use)
- [Irregular use](#irregular-use)
- [Commits](#commits)
- [Code Structure](#code-structure)
- [Webpack build](#webpack-build)
- [Code formatting](#code-formatting)
- [Deployment](#deployment)
- [Building the image](#building-the-image)
- [Future work](#future-work)
## Usage
This repo has a Docker image which you can use to run the Vue SSR server which serves the webapp assets.
The server runs on `8080` inside the container, so you'll need to map that for external traffic.
Here's an example with docker-compose:
```yml
version: '3'
services:
web-ui:
image: ghcr.io/digitalinteraction/catalyst-webapp
ports:
- 8080:8080
environment:
PUBLIC_URL: https://catalyst.not-equal.tech
API_URL: https://api.catalyst.not-equal.tech
REDIS_URL: redis://your_redis_url
```
> Get the [latest version](https://github.com/digitalinteraction/catalyst-webapp/pkgs/container/catalyst-webapp)
### Environment variables
There are some required environment variables, shown below.
| Variable | Description |
| ---------- | ----------------------------------------------------- |
| REDIS_URL | The redis connection uri |
| PUBLIC_URL | Where the app is, used for generating opengraph meta |
| API_URL | Where the api is, passed into the webapp through vuex |
There are some optional variables too:
| Variable | Description |
| -------------- | ------------------------------------------------------------- |
| APP_NAME | Set the app's name, used in opengraph and as the window title |
| APP_INFO | Set the app's description, used in opengraph |
| TWITTER_HANDLE | The twitter handle of the project (used in opengraph) |
| CUSTOM_STYLES | A url to a custom css file to load |
There are files you can override with bind-mounts.
| Path | File |
| ------------------------------------ | ------------------------------------------------------ |
| `/app/public/favicon.png` | The site's favicon |
| `/app/public/opengraph.png` | The site's opengraph image e.g. for tweets |
| `/app/public/config/categories.json` | Categorisation file, [see below](#categorisation-file) |
| `/app/public/config/filters.json` | Filters file [see below](#filters-file) |
| `/app/public/categories/*` | Custom category images (map to from categories.json) |
### Categorisation file
This file is used to define how card's are categorised in the interface.
You can specify what tags to map a category to and how that category looks.
It should be a JSON object like:
```json
{
"algorithms": {
"id": "algorithms",
"name": "Algorithmic Social Justice",
"image": "algorithms.png",
"color": "red",
"match": ["call:algorithmic-social-justice"]
}
}
```
- `id` should be a unique identifier for the category
- `name` is the name it is presented as
- `image` will resolve to files inside `/app/public/categories`
- `color` can be `red`, `yellow`, `blue` or `green`
- `match` is a set of labels that mean a card is part of this category
- You can also set a `_fallback` category which is used when a category didn't match
### Filters file
This file is used to define the filters that you can use in the interface.
It should be a JSON array in the form:
```json
[
{
"id": "call",
"title": "Call for proposal",
"prefix": "call:",
"logic": "or"
}
]
```
- `id` should be a unique identifier for the filter
- `title` is how the filter is presented in the interface
- `prefix` is a prefix for tags which this filter by
- `logic` is how the filter should behave, either `and` or `or`
### Trello key-values
You can also set these vaules from the Trello `CONTENT_LIST_ID`
and they will tweak bits of text in the interface.
These are all optional.
| Key | Usage |
| -------------------- | ----------------------------------------------- |
| `[home.title]` | The title on the homepage, shown after the hero |
| `[home.strapline]` | The strapline on the homepage, in the hero |
| `[home.searchLabel]` | The label next to the search field |
| `[home.noMatches]` | A label when filtering returns no responses |
| `[home.noResponses]` | A label when there are no responses at all |
| `[about.title]` | The title of the about page |
| `[about.subtitle]` | The subtitle of the about page |
| `[about.long]` | The content of the about page |
| `[about.short]` | The info displayed next to a project detail |
| `[notFound.title]` | The title of the not found page |
| `[notFound.message]` | The message of the not found page |
## Development
### Setup
To develop on this repo you will need to have [Docker](https://www.docker.com/) and
[node.js](https://nodejs.org) installed on your dev machine and have an understanding of them.
This guide assumes you have the repo checked out and are on macOS, but equivalent commands are available.
You will also need a Trello account which is used to pull the data from.
You'll only need to follow this setup once for your dev machine.
```bash
# Install dependancies
npm install
# Setup your client environment
cp .env.example .env.local
# Follow these instructions to get your Trello credentials
open https://github.com/unplatform/catalyst-trello-scraper#setup
# Setup your server environment
cp .env.server.example .env.server.local
```
### Regular use
These are the commands you'll regularly run to develop the API, in no particular order.
```bash
# Start up a redis instance, fetch projects and serve them with the api
# -> Run this in a new terminal tab
# -> Stop this with a Ctrl+C
# -> See `docker-compose.yml` for how it works
docker-compuse up
# Compile and run the vue-cli-service's server
# -> Internally uses webpack to transpile assets to html, css & js
# -> Stop this with a Ctrl+C
# -> Only runs the client, no ssr yet
npm run serve
open http://localhost:8080
```
### Irregular use
These are commands you might need to run but probably won't, also in no particular order.
```bash
# Generate the table of contents for this readme
# -> It'll replace content between the toc-head and toc-tail HTML comments
npm run gen-readme-toc
# Manually lint code with TypeScript's `tsc`
npm run lint
# Manually format code
# -> This repo is setup to automatically format code on git-push
npm run prettier
# Manually build all assets (html, css, js & images)
# -> Runs both the other build commands together
# -> Writes to dist/
npm run build
# Manually build the assets for the client
npm run build:client
# Manually build the assets for the server (creates a vue-ssr-server-bundle-json)
npm run build:client
# Run the ssr server
# -> Requires .env.server.local to be setup
# -> Stop this with a Ctrl+C
# -> Just runs the server, no file watching or restarting
node server/index.js
```
### Commits
All commits to this repo must follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
This ensures changes are structured and means the [CHANGELOG.md](/CHANGELOG.md) can be automatically generated.
This standard is enforced through a `commit-msg` hook using [yorkie](https://www.npmjs.com/package/yorkie).
### Code Structure
| Folder | Contents |
| -------------- | ------------------------------------------------- |
| dist | Where the html, css, js & img assets are built to |
| node_modules | Where npm's modules get installed into |
| public | Unmodified assets, served directly to the client |
| server | The source code for the vue-ssr express server |
| src | The source code for the web app |
| src/assets | Image assets that are built into the app |
| src/components | Reusable Vue components |
| src/data | Static information for the web app |
| src/sass | Custom styles written in sass |
| src/views | The app's views, components which are routed to |
### Webpack build
This repo uses [vue-cli-service](https://cli.vuejs.org/) to handle most webpack configuration,
including `babel`, `post-css` and processing `.vue` components.
There are some tweaks to the defaults, these can be found in [vue.config.js](/vue.config.js) and are detailed below.
- [shared.sass](/src/shared.sass) is automatically imported for each Vue component's `` tags (with variables and mixins)
- `process.env.VUE_APP_VERSION` is set to the package.json version
- It adds `vue-svg-loader`
- It sets up the required things for vue-ssr
### Code formatting
This repo uses [Prettier](https://prettier.io/) to automatically format code to a consistent standard.
This works using the [husky](https://www.npmjs.com/package/husky)
and [lint-staged](https://www.npmjs.com/package/lint-staged) packages to
automatically format code whenever you commit code.
This means that code that is pushed to the repo is always formatted to a consistent standard.
You can manually run the formatter with `npm run prettier` if you want.
Prettier is slightly configured in [.prettierrc.yml](/.prettierrc.yml)
and also ignores files using [.prettierignore](/.prettierignore).
## Deployment
### Building the image
This repo uses a [GitLab CI](https://about.gitlab.com/product/continuous-integration/)
to build a Docker image when you push a git tag.
This is designed to be used with the `npm version` command so all docker images are [semantically versioned](https://semver.org/).
The `:latest` docker tag is not used.
This job runs using the [.gitlab-ci.yml](/.gitlab-ci.yml) file which
runs a docker build using the [Dockerfile](/Dockerfile)
and **only** runs when you push a [tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging).
It pushes these docker images to the GitLab registry of the repo.
A slight nuance is that it will replace a preceding `v` in tag names, formatting `v1.0.0` to `1.0.0`.
```bash
# Generate a new release
# -> Generates a new version based on the commits since the last version
# -> Generates the CHANGELOG.md based on those commits
# -> There is a "preversion" script to lint & run tests
npm run release
# Push the new version
# -> The GitLab CI will build a new docker image for it
git push --follow-tags
```
## Future work
- n/a