We strictly follow SOLID principles to its core and make sure we design a loosely coupled architecture, which can be extended as it progresses. All the cross cuttings concern e.g. Logging and Caching are implemented using AOP to make its pure plug and play.
Architecture/Design used should have following qualities
- Use SOLID principles across the project.
- Don’t overengineer the code e.g. Don’t build for things you don’t need now.
- Must have scope for common practices e.g. dependency injection to make unit testing easier and make your application loosely coupled.
- Proper Logging, Log Analysis mechanism has to be in place.
- The proper caching mechanism has to be there and should never depend on a specific provider.
- Avoid using global variables in your methods, as it makes your unit testing much harder.
- Check for the cyclomatic complexity of your code.
- Use proper code comments and generate documentation from that.
- Do not use your database classes as DTO objects as it makes it harder to accommodate any changes at a later stage and also shows implementation details to the consumer.
- Always support versioning of your API layer to accommodate future changes.
- Always use proper HTTP error codes to communicate, Don’t send everything as 500.
- Mobile apps should be built to use different config per environment.
- Always set up CI/CD pipelines for even the smallest of projects.
- Use DI framework e.g. Dagger2 and SWInject for your mobile apps.
- Use UI Tests to ensure your application runs smoothly across devices.