Skip to content

Manifest-Labs/knowhow-animation

Repository files navigation

knowhow-animation

GENERAL

FOLDER ORGANIZATION

This is the folder organization for the lottiefiles within the knowhow-animation GitHub project. We are going to have three main folders and elements: default elements (like the index and node_modules), app and landing as follows:

  • app → Contains animations, graphs and explanations used exclusively inside the app.
  • landing → Contains animations, graphs and explanations used exclusively on the landing page.
  • chromeExtension → Contains animations used exclusively on the Chrome extension

Within the app folder we are going to have:

  • Gradients → Contains gradients used around the project. We currently only have one gradient but this opens the possibility to have more and organize them in the future.
  • Graphics → Contains graphics such as animated people.
  • Icons → Contains icons such as loaders, carrots, typing and ellipsis.
  • Dashboard → Table, processes and graph loaders that are generally used in dashboard settings.
  • Logos → different animations that are done using the knowhow logo.

Each folder contains their own index.js file which includes the imports to be used in the different repositories (mobile, desktop and landing).

HOW TO ADD NEW LOTTIES

  1. Add the lottie files to the folder according to the folder organization above.
  2. In the index.js file in the folder you added the lottie create a new _variable to refer to the lottie file and then also update the _default export file with this newly created _variable
  3. Create a new release. For small changes we just add a decimal to the release.
  4. With the new release number make sure you update the app and desktop repositories package.json
  5. You should be able to use the lottie files now in your work.