Project Structure

When starting a new project, organizing your files and directories effectively is crucial for maintaining a clean and scalable codebase. Below is a recommended project structure for both frameworks:

Repository Project File System Structure

src/         #This is the main source directory containing all the application-specific code. All subsequent project folders will reside in this directory. 
tests/       # This directory contains all the tests for the application
docs/        # This directory contains all the documentation for the application

Repository Solution Structure

src/                  # This is the main source directory containing all the application-specific code. All subsequent folders will reside in this directory. 
|-- APIs/             # Solution directory for all APIs projects
|-- Commons/          # Solution directory for all common projects
|-- Consumers/        # Solution directory for all consumer projects
|-- Proxies/          # Solution directory for all proxy API projects
|-- SDKs/             # Solution directory for all SDK projects
tests/                # This directory contains all the tests for the application

Project Naming Conventions

In our development environment, we enforce specific naming conventions to maintain consistency and clarity across all solution files. It is mandatory that all solution files begin with the prefix "Hubtel." followed by the project name.

Project Type and Suffix Recommendations

To further categorize and differentiate projects within our solution, we recommend using distinct suffixes for each project type. Below is a table outlining the project types and their corresponding recommended suffixes:

Project Type	Recommended Suffix
API	*.Api
Consumer	*.Consumer
Background Job	*.Job
SDK	*.Sdk
Console App	*.Console
Unit Test	*.Tests

All solution files within our development environment must begin with "Hubtel." to ensure consistency and easy identification.

Example Project Structure

For example, suppose we have a solution named "Hubtel.Riders." Following our naming conventions and recommendations, the project names within this solution would be:

• Hubtel.Riders.Api
• Hubtel.Riders.Consumer

How to Implement

When creating new solution files or adding projects to existing solutions, ensure that the file names start with "Hubtel." and adhere to the recommended suffixes based on the project type. This practice facilitates easy identification and navigation within our development environment.

Was this page helpful?

Happy React is loading...