mbiesiad/front-end-monorepo

A rebuild of the front-end for zooniverse.org

Zooniverse Front-End Monorepo

️Take a look at our roadmap! 🛣️

---

Table of Contents

• Requirements
• Monowhat?
• Getting started
• Helpful Guides
• Packages
• Helpers
• Conventions
• NPM
• Packages directory
• Deployment
• License

Requirements

• Browser support
• Node 14
• Git
• Yarn

Node, git, and yarn can be installed through homebrew on MacOS. If you need to support more than one version of node at the same time, you can consider installing it though nvm instead of homebrew

Monowhat?

This monorepo is managed with Yarn Workspaces.

Yarn Workspaces allow us to maintain package modularity for javascript projects that have interdependency. Organizationally, they allows us to track issues, pull requests, and progress for all related packages in one place.

Getting started

Docker

You can run the code locally in Docker, which avoids needing to install Node or yarn.

git clone git@github.com:zooniverse/front-end-monorepo.git
cd front-end-monorepo
docker-compose build

docker-compose up runs local production builds of the project app at http://localhost:3000 and the content pages app at http://localhost:3001

docker-compose down stops the running container.

docker-compose run --rm shell runs an interactive shell on the Docker image.

Development environments for individual packages can be run from the package directories. For example:

cd packages/app-project
docker-compose up

to run a develeopment server for the project app.

With Node and yarn

Alternatively, you can install Node 14 and yarn and build the monorepo packages.

git clone git@github.com:zooniverse/front-end-monorepo.git
cd front-end-monorepo
yarn bootstrap

The bootstrap script will install the dependencies and build any local packages used as dependencies.

Helpful Guides

• Yarn docs

Packages

See each package's folder for more specific documentation.

package name	folder	description
@zooniverse/async-states	packages/lib-async-states	Frozen object of async states to use in data stores
@zooniverse/classifier	packages/lib-classifier	Classifier view components and state which can be exported modularly or altogether as a working classifier
@zooniverse/fe-content-pages	packages/app-content-pages	Server-side rendered application for documentation / info pages, such as Publications.
@zooniverse/fe-project	packages/app-project	Server-side rendered application for a project (anything at /projects/owner/display_name)
@zooniverse/grommet-theme	packages/lib-grommet-theme	The style definitions for a Zooniverse theme to use with Grommet
@zooniverse/panoptes-js	packages/lib-panoptes-js	Panoptes API javascript client. Functional HTTP request helpers built on top of superagent
@zooniverse/react-components	packages/lib-react-components	A set of Zooniverse-specific React components, built using Grommet

Conventions

NPM

All packages built from this monorepo should be scoped to zooniverse, e.g. grommet-theme becomes @zooniverse/grommet-theme.

packages directory

Libraries for publishing to NPM should have their directory names prefixed with lib-, e.g. /grommet-theme becomes /lib-grommet-theme.

Apps should have their directory names prefixed with app-, e.g. /project becomes /app-project.

Deployment

Deploys to production and staging are handled by Jenkins using Docker images.

Deployments to a staging Kubernetes instance that uses Panoptes production are triggered by merges to master. This is used for manual end-to-end behavior testing for new code and design reviews. https://frontend.preview.zooniverse.org/projects/:project-owner/:project-name/ proxy redirects to the new NextJS app while the rest of sub-domain redirects to PFE. Staging projects can be loaded by adding this query param to the URL: ?env=staging.

Deployments to a production Kubernetes instance are triggered by committing a production-release git tag on master. This can either be done using the git CLI or using the lita deploy command on slack. https://www.zooniverse.org/projects/:project-owner/:project-name/classify proxy redirects to the new NextJS app while the rest of the domain redirects to PFE. Currently the only project that is configured to do this is Planet Hunters TESS. Eventually more projects will migrate when they migrate to the new classifier.

More information is available in ADR 12 and ADR 17

Environment variables

• PANOPTES_ENV: sets which Panoptes API endpoint to use.
  • production will use https://www.zooniverse.org/api
  • staging will use https://panoptes-staging.zooniverse.org/api.

The yarn build scripts default to production for libraries if PANOPTES_ENV is not specified. The apps are always built to the production API.

• NODE_ENV: the webpack build mode for libraries and the NextJS apps (production, development or undefined.)
• APP_ENV: sets the Sentry environment (development, staging or production) when reporting errors.
• CONTENTFUL_ACCESS_TOKEN: access token for the Contentful API. Should be kept secret.
• CONTENTFUL_SPACE_ID: space ID for Zooniverse About pages in Contentful. Should be kept secret.
• CONTENT_ASSET_PREFIX: NextJS asset prefix for app-content-pages.
• PROJECT_ASSET_PREFIX: NextJS asset prefix for app-project.
• COMMIT_ID: the latest git commit hash. Used for versioning Sentry releases and recorded in classification metadata.

Docker images

• zooniverse/front-end-monorepo-staging: Built from the Dockerfile in the root directory. It runs yarn install and builds all the libraries and apps from the latest main branch commit.
• zooniverse/front-end-monorepo-production: Built from the Dockerfile in the root directory. It runs yarn install and builds all the libraries and apps from the production_release tag.

Publishing

When publishing an individual package to npm, first cd into the repo you would like to deploy (within the packages folder), then:

1. Update changelog and commit
2. yarn version --major|--minor|--patch --no-git-tag-version (use the desired semvar here)
3. Update other packages to reference the newly updated package version
   • Ex: If updating lib-react-components to 1.0.0 from 0.7.2
   • lib-classifier should point to the new 1.0.0 version of lib-react-components
4. git push origin name-of-branch
5. Merge branch
6. Checkout master, pull for latest
7. Build the package with yarn build from the package dir, where available
8. yarn publish --new-version <version> --access public from the package dir
   • yarn v1 publish command tries to version bump with the publish command. You can specify the exact same version from step two with the --new-version variable.
   • --access public publishes the package publicly
   • You can optionally login in to npm prior to this using npm login and storing an auth token in an .npmrc file

---

License

Copyright 2018 Zooniverse

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.