I
I
Ignitus
Search…
πŸ“„
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
Export as PDF
Copy link