Skip to content

Latest commit

 

History

History
119 lines (85 loc) · 7.39 KB

overview.md

File metadata and controls

119 lines (85 loc) · 7.39 KB
Raw

Atlas technical overview

This document tries to outline all the conventions/tools/services used to make Atlas work.

Conventions

Some of the used tools/tech

Monorepo

Please note that this repo is based on Yarn Workspaces and because of that, to install new dependency from root, you need to use the following pattern: yarn workspace [package_name] add [dependency_name]. You also have the option to install dependencies directly from package directory using yarn add [package_name]

Repo structure

  • .github/ - GitHub stuff - currently PR checks actions
  • ci/ - continuous integration stuff
    • nginx/ - nginx config directory
    • build-docker-atlas.sh - build script for atlas app Docker
    • build-docker-meta-server.sh - build script for meta server Docker
    • docker-compose.yml - docker compose for meta server Dockers
  • docs/ - Atlas-related documentation - technical & community
  • packages/ - workspace apps
    • atlas/ - main app
      • .storybook/ - Storybook configuration
      • public/ - static assets used to build the app
      • scripts/ - some helper scripts for common
      • src/ - the source code
        • api/ - everything related to integrations with external services
        • assets/ - assets to be used from within the source code - images/animations/etc.
        • components/ - components used by Atlas
        • config/ - everything related to config - route URLs, env variables, etc.
        • hooks/ - hooks for reusable functionalities
        • joystream-lib/ - code for interacting with the Joystream blockchain
        • providers/ - contexts, stores and logic for different features
        • styles/ - theme for styling the app - design tokens, global styles
        • types/ - global Typescript related code
        • utils/ - common utilities - e.g. for formatting dates etc.
        • views/ - all the top-level views displayed by the router
        • main.tsx - app entry-point
        • App.tsx - React entry-point
    • atlas-meta-server - meta tags pre-rendering server
    • atlas-proxy-worker - Cloudflare Worker to enable Atlas social previews on Cloudflare edge network
    • atlas-geolocation-worker - Cloudflare Worker to enable picking closes distribution operators
    • atlas-avatar-service - users avatars upload service

DevOps

We currently use GitHub actions and Vercel for all our DevOps needs. On every PR we run GitHub actions to ensure the code follows the linting rules. Also, for every PR, Vercel previews are generated so that it's easy to explore the updated app.

The deployed version of Atlas (at https://play.joystream.org) is also hosted by Vercel. This one gets redeployed on every push/merge to master.

Releasing

Atlas is versioned using Semantic Versioning. The version is stored in package.json in the packages/atlas package. There is also a CHANGELOG.md file in the root of the repo that contains all the changes between versions. Every PR that contains non-trivial change should add entry to the CHANGELOG.md file in the Unreleased section, explaining what was changed.

Whenever we merge to master, we should create a new release. This is done by:

  1. Creating a release: X.Y.Z (where X.Y.Z is the version number) commit that bumps version in packages/atlas/package.json and replaces the Unreleased section in CHANGELOG.md with appropriate version number.
  2. Creating a Git tag in the format vX.Y.Z.
  3. Pushing the commit and the tag to master.
  4. Creating a new GitHub release with the same version number as the tag, and supplying it with the CHANGELOG.md entries.

Meta tags pre-rendering

Because social media crawling bots can't handle SPA apps, we decided to pre-render HTML meta tags for social media previews purposes. Whenever a request from a social media crawler (detected via User-Agent header), we redirect it to the atlas-meta-server which returns pre-rendered HTML, in any other case regular application is served.

There are 2 methods of handling the incoming traffic and redirecting:

  1. For self-hosted version of Atlas - docker-compose setup located in ci/ directory. This will run docker-compose with NGINX that redirects any incoming traffic. Social crawlers' requests get sent to atlas-meta-server instance, and otherwise static files are served.
  2. For jsgenesis-run Atlas production instance - Cloudflare Worker setup located in packages/atlas-proxy-worker. This method uses Cloudflare Workers that runs redirection logic on Cloudflare edge network, allowing redundancy and very fast response times. If the request is a regular one, it gets redirected to Vercel deployment.

To build and run atlas-meta-server for production:

yarn docker:meta-server
docker run -e GRAPHQL_URL=https://orion.joystream.org/graphql -p 80:80 -d joystream/atlas-meta-server

To run full self-hosted setup:

yarn docker:atlas
yarn docker:meta-server
cd ci
docker-compose up -d

Selecting distributors

As explained in the architecture doc, distribution providers are used to fetch assets from the Joystream storage network. To pick the closest providers and ensure the best latency, Atlas uses a Cloudflare Workers that acts as a serverless function, returning the user's location (latitude + longitude), based on their IP address. This location is later used to find the closest distributors. Code for this worker can be found in packages/atlas-geolocation-worker.

Architecture

For full technical overview of Atlas architecture, see architecture.md.

Styling

All styles for components/views used in Atlas should use design tokens defined by the designers. You can find the raw tokens inside the atlas-resources repo. The tokens define things like colors, typography, borders, etc. There is a script called tokens (yarn tokens) that will fetch the latest tokens from the resources repo and build them into usable CSS variables. Then in any place in the code you can import the cVar function from @/styles and use any of the tokens. Example:

import { cVar } from '@/styles'

const Component = styled.div`
  background-color: ${cVar('colorBackground')}; // this will translate into var(--color-background)
`

Icons & illustrations

Atlas uses a bunch of different SVG files for icons and illustrations. All of those are pre-processed via a yarn svgs:illustrations / yarn svgs:icons-generate script that generates React components out of SVGs using svgr. Then we import those components inside our code.

All icons used in the app are created by the Atlas design team and come from Figma. To make the workflow easier, we have created a script that fetches all the icons directly from Figma and saves them in the repo. This way we can make always keep Figma and the app up to date. The script can be found in scripts/figma-import and can be run with yarn svgs:icons-import.