Managing Frappe/ERPNext Custom Code via GitHub

Ensuring safety of your custom code even in the event of an update from ERPNext and/or Frappe Framework

Language: english

Note: 4.4/5 (24 notes) 1,002 students New course

Instructor(s): Geoffrey Karani

Last update: 2022-11-13

What you’ll learn

How to setup your ERPNext/Frappe development environment the right way
The importance of having a custom app when customizing ERPNext
How to setup a GitHub repository
How to synchronize custom code between GitHub and your Development Environment
Ensuring your customization doesn’t get overwritten when you do an update for ERPNext

Requirements

Basic Python
Basic JavaScript

Description

When you are a software developer, GitHub is a handy tool when it comes to version control. GitHub also helps us to manage how code goes to the production server. When doing development with ERPNext and/or the Frappe Framework, we can also manage our code with GitHub.

All development and any customization needed is done on the local instance. Once a feature is working well locally, or maybe its a completed bug fix, we push the code to whatever GitHub branch that is managing the code. Our remote instance then pulls the code from GitHub.

There are two ways for getting the code to the live server from GitHub. You can either Pull the code manually or you Automate with GitHub actions. Either way, this is a very effective process that will ensure your custom app is safe and any customization you do is being launched smoothly.

This is all taken care of in this series.

TOPICS COVERED

Introduction
Walk-through
Finalizing the installation of Local and Remote Instances
Creating a custom app and pushing the code to GitHub
Creating a DocType and pushing its code to GitHub
Getting custom app from GitHub to our remote/cloud server
Making a change to the DocType and deploying the changes to the cloud server with bench migrate

Who this course is for

ERPNext Developers who want to understand how to customize ERPNext and maintain their custom code in the event of an update
Software Developers who want to understand how to use GitHub to manage their code

Course content

Introduction
- Introduction
- The Walk-through
- Finalizing installation of both instances
- Create a custom app and push it to GitHub
- Creating a DocType and Pushing its code to GitHub
- Getting Custom App From GitHub To Our Remote Server
- Making a change to the DocType and deploying the changes to the cloud server