📄Dir. Structure

Source code directory structure.

The source code of Ignitus is separated into a several directories , mostly following easy to understand separation conventions.

Here is the brief overview of source code directory structure.

src
├── ignitus-AboutPage/ - Components that constructs About page.
|   ├── ignitus-About/ 
|   ├── ignitus-CoreTeam/
|   └── ignitus-Team/
|   
├── ignitus-Api/ - Responsible for handling server request/response. 
├── ignitus-Authentication/ - Composed of authentication components.
|   ├── ignitus-CommonAuthenticationInterface/
|   ├── ignitus-CommonLoginInterface/
|   ├── ignitus-CommonSignupInterface/
|   ├── ignitus-ProfessorLogin/
|   ├── ignitus-ProfessorSignUp/ 
|   ├── ignitus-StudentLogin/
|   └── ignitus-StudentSignUpFlow/
|   
├── ignitus-CareersPage/ - Holds logic for CareerPage component.
├── ignitus-Dashboard/ - Composed of components that constructs Dashboard.
|   ├── ignitus-DashboardHeader/
|   └── ignitus-StudentDashboard/
|   
├── ignitus-HomePage/ - Components that constructs Home page.
|   ├── ignitus-Contributors/
|   ├── ignitus-GetStarted/
|   ├── ignitus-Home/
|   ├── ignitus-Introduction/
|   ├── ignitus-SupportedBy/
|   ├── ignitus-Testimonial/
|   └── ignitus-WhatWeDo/
|   
├── ignitus-Routes/ - Here routes are seperated into different categories
|   |                 to ensure code redability. 
|   ├── ignitus-AuthenticationRoutes/ 
|   ├── ignitus-DashboardRoutes/
|   ├── ignitus-PrivateRoutes/ - Only accessible to authenticated user. 
|   ├── ignitus-PublicRoutes/ 
|   └── ignitus-UserInterfaceBookRoutes/
|   
├── ignitus-Shared/ - 
|   ├── ignitus-DesignSystem/
|   |     ├── ignitus-Assets/ - Comprises of svg, Images.
|   |     ├── ignitus-Atoms/ - Comprises of buttons, dropdowns etc.
|   |     ├── ignitus-Layout/
|   |     ├── ignitus-Molecules/ - Comprises of overlay, scrollBar etc.
|   |     ├── ignitus-Organisms/ - Comprises of Footer, Nav. etc.
|   |     └── ignitus-Templates/
|   ├── ignitus-ErrorHandlingComponents/ - 
|   |     ├── errorBoundary/ 
|   |     └── errorHandling/
|   ├── ignitus-Utilities/ - Comprises of helper functions, custom-hooks
|   |     |                   & global shareable components etc.
|   |     ├── Components/
|   |     ├── HelperFunctions/ 
|   |     └── reactHooks/
|   └── types/ - Here globalTypes are defined.
|   
├── ignitus-UserInterfaceBook/
|   ├── Components/ - Container components used to display components 
|   |     |           here http://www.ignitus.org/interface 
|   |     ├── Atoms/
|   |     ├── Layouts/
|   |     ├── Molecules/
|   |     ├── Organisms/
|   |     └── Templates/
|   └── InterfaceSideNavigation/ - https://www.npmjs.com/package/side-navigation-react