Skip to content

Latest commit

 

History

History
115 lines (82 loc) · 2.67 KB

README.md

File metadata and controls

115 lines (82 loc) · 2.67 KB
Raw

Guide on how to start a project

Note this project is setup using monorepo architecture (NX) workflow

This repo contains both backend and UI portion of a project itself so, this readMe will guide user on how to get started.

Backend portion

Backend project is created using Node.Js framework called Express.Js. And for the project folder architecture it follows MVC pattern. For the database this project use MongoDB which is a NoSQL database and for the file storage it use AWS S3 bucket with cloudfront.

How to start a project

Here's a quick way to start Backend

git clone <project_url>

yarn

For Development Version

yarn start:backend

For Built/Production Version

yarn build:backend

After the build is success, all the built files are stored under the dir name dist

cd dist/apps/practitioner-backend

node main.js

UI portion (Frontend)

Frontend project is created using react framework called Next.Js. For the styling it use TailwindCss. To understand more about project folder structures please scroll down to folder structure sections.

How to start a project

Here's a quick way to start UI

git clone <project_url>

yarn

For Development Version

yarn start:ui

For Built/Production Version

yarn build:ui

After the build is success, all the built files are stored under the dir name dist

cd dist/apps/practitioner-ui

npm start

##Project Folder Structure Here's a folder structure to understand where the file exists.

  • apps (where all the main application files exists including backend and ui)

  • dist (where all the build files exist) *libs (library folder where all the library responsible for creating a application sits, component libs or utils etc)

  • public (where public files like assets and images are set)

.
└── PRACTITIONERMANAGEMENT/
    ├── apps/
    │   ├── practitioner-backend
    │   ├── practitioner-ui/
    │   │   └── NextJS(files)
    │   └── practitioner-e2e
    ├── dist/
    │   ├── practitioner-backend
    │   └── practitioner-ui
    ├── libs/
    │   ├── components (essential components like button, alert)
    │   ├── constants (constant files like api-routes)
    │   ├── store (root state/ main state store)
    │   └── utils (utility functions)
    ├── tailwind.config.js
    ├── nx.json
    ├── package.json
    └── tsconfig.base.json

Note: Please use yarn as it's perferred version for development for this repo.