Navigating Repo - beingtmk/nodejs-starter-kit GitHub Wiki
First, read the project structure docs from the repo wiki.
All the modules are stored in the modules folder in the root folder.
Each module consists of folders client-react, client-react-native, common and server-ts. As the name suggest the corresponding code can be found in the respective folders.
This folder consists -
- File
index.jsx- This is where all the routes corresponding to the module can be found.
- File
index.native.jsx- The is where the routes for the native app are declared.
- Folder
containers- The routes declared in
index.jsxfile points to some file, those files are stored in containers, this file contains part of the component where it communicates with the server.
- The routes declared in
- Folder
components- The files that are present in
containerspoint to the files present in this file, these file contain the styling and layout part of the component.
- The files that are present in
- Folder
graphql- This is the folder that contains all the
.graphqlfiles which store the corresponding structure required for a api request.
- This is the folder that contains all the
- Folder
locals- This folder contains the
translation.jsxfile in the corresponding folder of their classified language, this translation.jsx file is used for loading the data on the webpages using thetranslatefunction.
- This folder contains the
This folder consists -
- Folder
migration- This folder consists the knex migration file
- Folder
seeds- This folde contains the seed data
- File
sql.js- Used in api
- File
server.js- Used in api
While working with the repo keep the following things in mind ->
-
Whenever you have to import a file/function/component from other component follow the folling format Don't->
// Import from another module import { PageLayout } from "../../../look/client-react/ui-antd/components/PageLayout";
Do ->
import { PageLayout } from "@gqlapp/look-client-react";