Teachers! Did you use this instructable in your classroom?
Add a Teacher Note to share how you incorporated it into your lesson.
Step 1: Simplicity Is Key
Whether you decide to outsource all or part of your project, the most important rule is to keep coding as simple and consistent as possible. This means dividing your project into single-export files and clearly naming each one. This makes it easier to find them in the future.
It also encourages decoupling, which keeps every part of the code fully independent. Decoupling also ensures that dependencies are passed on via arguments or injections, which makes testing and maintenance more straightforward.
If code extends beyond 120 characters to the right, or over 500 lines downwards, it should be divided. The same applies when an if-statement goes three levels deep.
Keeping things simple reduces the need for developers to provide lengthy documentation and extensive comments. The coding process can also be simplified by using open-source packages located on sites like npmjs.com.
Step 2: Choosing Your Framework
Instead, identify the specific requirements of your outsourcing project, then find the framework that can do the job best. Here are some of the main options to consider:
Angular, VueJS and Ember deploy a black-box approach, which removes the need for architecture planning. Their inflexible structure makes them quick and reliable frameworks for web applications. Their approach is more forgiving of mistakes than React, however, they sometimes offer less freedom.
Step 3: Employing Version Control
With version control, your outsourcing provider needs to use commits, branches and be able to merge. They need to know how to resolve conflict and return to previous commits. They should also remember to give meaningful commit messages.
If something goes wrong with your project, version control enables your outsourcing provider to recover previously written code that can save significant amounts of time that would otherwise be lost to lengthy repair.
Step 4: Testing and Configuration
If your application uses global values, API endpoints, feature toggles or third-party credentials, they will need to go in separate config files. Config files make management easier when your application becomes available both on the server and locally. By creating config files early, your outsourcing provider will be able to adjust how the environments behave and select which features are available.
Step 5: Storing Data Responsibly
The challenge of state management is to ensure that the application is synchronized with the data that’s stored in the databases. Components need to deliver the same data sets, synchronize any changes made by the application user and react to any changes that are made on the server. This is easier to achieve if the whole application has a single source of truth, be it a library or a service.