Skip to content
This repository has been archived by the owner on Jul 1, 2020. It is now read-only.

Dir Structure

Aniket Prajapati edited this page Jun 12, 2020 · 2 revisions

FireJS projects usually look something like this.

Project    
└─── out                 
│   └─── dist             
│   |    └─── lib           
│   |        └─── map   
|   └─── .cache
|   |
|   └─── .fly
|   
└─── src    
│   └─── pages        
│       │   index.js      
│       │   about.js
│       │   404.js          
│       │   ...    
│    
│   └─── static
│       │   example.png
|
| firejs.yml 

Don't like it? No problem, change it effortlessly using firejs.yml file or if you are in a hurry change them using the command line interface.

👀 A Quick Explanation

The src dir is the place where you'll put all the bits and pieces of your website.

  • The pages dir will hold all the pages of your website. Read this for more info.
  • The static dir will hold all the static assets of your website. These assets include stuff like images, videos, gifs etc.

The out dir is the place where FireJS will store all of its bits and pieces for your website.

  • The dist dir will hold all the chunks, HTML and maps when you export your project using [-e, --export] flag

    • The lib dir will hold all the chunks and maps.
      • The map dir will hold all the page maps. These are nothing but .map.js files which will contain a registry of all the chunks and data required by the respected pages.
  • The fly directory will hold the chunks exported by [-E,--export-fly] flags. This dir is required for SSR using CustomRenderer.

The `.cache` dir will hold the babel cache and other stuff personal to FireJS.

.cache
     |  .babelCache
     |  disk
     |  f.......js
  • .babelCache dir will hold the cache required by babel for fast builds.

  • disk dir will hold the bits and pieces of your website when you use [-d, --disk] flag.

  • f.......js is a chunk containing react, react-dom and react-server combined. FireJS uses this file to SSR your site. Usually its name fa3bae0103d2d9b32a978.js.

🏡 Home

Getting Started
Advance
Tips and Tricks

🗒️ All examples in this documentation are written in typescript

Clone this wiki locally