Skip to content
This repository has been archived by the owner on Apr 25, 2024. It is now read-only.

Latest commit

 

History

History
31 lines (18 loc) · 1.93 KB

CODEBASE.md

File metadata and controls

31 lines (18 loc) · 1.93 KB
Raw

Codebase overview

This document will give you a high level overview of the modules and components of the application and how they work together.

Dependencies

The CC Search frontend is built using Vue.JS as its main view library. The app uses Vocabulary for vue components and global CSS.

It uses NuxtJS as a meta framework to handle serveral key functions:

  • Server Side rendering in production
  • Lifecycle methods for data fetching on client and server-side page loads
  • Building the application for production

If something in the codebase confuses you, it may be a feature of NuxtJS, so make sure you check out their documentation.

NuxtJS is built on top of standard libraries in the Vue ecosystem. It uses Vue-Router as its routing library and Vuex as state-management library.

Jest is used for unit tests. Cypress for end-to-end (e2e) tests, to simulate the user experience and make sure all of our unit-tested components are working in harmony.

Basic repository structure

In the project root

The root of the repository contains several configuration files for code formatting, and configuration, for prettier, nuxt, docker, eslint, and other config files

nuxt.config.js is an important file. It contains several key pieces of configuration. You can read more about the NuxtJS config file here.

  • environment variables are set in the export const env = {} object. Varibles are set with camel case names like this process.env.varNameGoesHere and their default values are formatted in the more conventional process.env.VAR_NAME_GOES_HERE format.
  • Default HTML metadata and Nuxt plugins are added
  • /src All JavaScript code lives in the src directory.