A Step-by-Step Guide on Installing the Wagtail Codebase on a Local Machine for Contribution.

My name is Umar Faruk and I'll be taking us through the step-by-step procedures on how to set up a wagtail for contribution purpose. Let's just come back here and this is the guide. So um in order to set up Wactail for contribution purpose you need some prerequisites and those prerequisites comes as an you need uh python yeah so so you need to have python installed on your machine on your a computer and then you you need to have a load installed on your computers so you could see I have this

the Python and then the node and after installing Python you need to ensure that you have uh uh you've actually installed virtual environment so so just go ahead and clear my screen and the next thing will be to uh Next thing will be for me to navigate into my Wagtail directory. So so um Yeah yeah so um so I'll now get to my documents and then I have this directory called virtualMs this is where I install all my virtual environments so I just love to keep my things uh straightforward

so as you can see I have some couple of uh Some I have some couple of virtual environments already. This is a MyJango tutorial, Wactail House, Wactail Tutorial. So these are virtual environments. This is also a virtual environment. Clear my screen and the next thing to do is I'll go ahead to create a virtual environment using the command virtual inf and I'll call it mark tutorial yeah so I'll just run this and okay Nice, so these have actually created a virtual environment called Mac Tutorial for So next thing is navigate into

Mac Tutorial and yeah so And then it shows that I'm in my virtual environment directory right now, but then I need to activate it. So I will go ahead to run the command source being activate. So this command will activate our virtual environment such that whatever we are doing, we could explore the future of we working in a in in in a virtual environment. So you could actually see that with this indication it shows that I have successfully activated my virtual environment. So okay my screen and the next thing we would like to do is or

like to go online to the um worktail directory work tail repo so this is the worktail repo the best solution or the ideal solution is you just need to fork it fork the worktail repo to your own repository and from your repository you should clone. But I won't be doing this because I have uh 10 commits ahead of the Wactail repository that's because I created some pull requests that haven't been marked so I'll just go ahead to the worktail repo itself and I try to clone. So I copy the command and I move on to and my Wattle

directly type the command git clone and I input this bam so you can see cloning into Wattil so it's currently um downloading and this might take a while depending on your internet connection. So I would just go ahead to I'll pause it. I'll go ahead to pause my video and I'll resume when it's done. Okay, so um So let's pause that. Okay, so we are back and uh The process is almost done. So we're almost done with cloning our Wagtail repository.

And uh Just give it a few few seconds more to complete the process and uh so After this, uh let's go to the documentation to see what guide do they have for us. So there's a development guide So we navigate into the directory and then we try to install the dependencies for testing and documentation purpose. So um Okay, so we have the um cloning process being completed. Okay, nice. So we've just successfully cloned our um repository and the next step

is we now need to navigate into our directory and then we run this command so I'm just going to navigate so we have a Wagtail directory. So I'm in my Wagtail directory in my virtual environment called Mac Tutorial. So I will just go ahead and Copy this command and then we run the command here. This command is going to install all dependencies needed for our testing, for the automated testing and for the docs. So it's currently installing the dependencies and We just need to wait for it to complete. Yeah.

So um give it some few minutes to complete the process and then We move on to the next part of the um process. So it's currently Collecting a lot of packages, I think. It's a really big library so it needs to use a lot. Okay, so we've just had this uh this is completed now. Uh okay, it's not done, it's almost It's almost it's almost so it's currently installing the collected packages

and then Okay, well that's interesting. So we've successfully had this and the next part of the process is we need to run the npmci this logic will help us to build static files When I say static files I mean all the JavaScript, the CSS files, we have the hundreds of files we have so everything is gonna get installed with this command so just wait for it it might also take a while so And I might need to go on a force again like the other time. So

pending the time it's going to complete the running process and uh so alright so Oh yeah, alright. So we have this uh the command run successfully, the NPM CI, so it's been able to um compile helpers to build our side files and showing 27 vulnerability six level you will always get this you always get this uh we now have this and the next part of the uh Operation is we need to compile our current assets so then we try to run the command then we say

Oops, I didn't copy that the right way. Okay, so just go ahead npm run build and I'll just run that so this will So this is what's going to help me build the actual static files and this command is the command you will have to run whenever you make modifications to your um SCSS files while trying to contribute or your javascript files you have to run this command so this command will um help you to uh compile your static files again That's for example while going through the um Wactel directory

you get to see some SCSS files and CSS files. So the CSS files have been bundled I'm using this command. So this command picks are the actual codes in your SSS files or your JavaScript files and For example the the CSS files it picks the this command picks the uh codes there and then it bundles them into your CSS files. Basically, as we say, this command helps you to compile your assets. Okay, nice. So we could see a lot of greens here. I I don't need to start analyzing From what we could actually see we've seen successful and then it ran in 68

,551 milliseconds. That's like six seconds. Uh that's like uh I think uh yeah six seconds So that's done. The next part of it is we now have a code base set. by running all these commands so let's try to clear our screen yeah so we've had our screen cleared uh the next thing we could actually do is we can actually say we want to create a new site yeah so let's go ahead and say Wag till so we say work till start so we say um

work till start uh uh uh demo So it's yeah, so I'll just Okay. Oops uh Okay, so it's uh small letter s uh i made a mistake there so we've successfully created uh a new site called demo site with the work tail start my uh work tail start demo site command So the next part of it is um we need to actually install the dependencies for this um site which we just created so I'll just go ahead and navigate into my demo site

so once I'm there I could say peep uh install Dash R and then requirements means the TXT. Yeah, so this is actually installing the requirements for um the new site which I just created. So it's not like i'm bringing it off my head from a far place but we could actually see that here okay so this is how you do that so when you 've So on installing our codebase we run this command wracktail starts my site bitr On

instance here we have demo site and then the next part is we install the requirement. txt And then we run the migrate command and then we create a an admin for that and then we run the manage the pyron server. So let's try to pick up this command which is uh So can I point you in so I'll just go okay so We we've successfully installed that and uh I'll just go ahead Python many. py migrate so this many. py migrate you could see it's actually

um creating the tables and all of that part of maybe caches or what we needed it's just like uh prerequisite so the next part of it is we need to create an admin so that's why we are running the python manage. py creates super user and I just go ahead run the command here Okay username let's give it a name and then email address I could just give it a uh admin at gmail. com Yeah so password we could give it admin

so admin Yeah, I want to bypass the password bypass password validation critical user anyway. Yes So it's a small so we've successfully created the super user and uh the next part is we want to um launch our site so I could just say pythonmine. py run server which will eventually start up our site and we could actually visit that. So it currently shows that our site is running and we could actually visit the site to see

that our basic site is actually running so just go along here oh yeah this is nice so we could actually see This is a basic site and it's actually running so go say admin let's try to log in as an admin and Okay, so this is it. We are trying to sign in as an admin. So then I just click on the sign in So

let's wait to see what we got here and uh Yeah, so welcome to the demo site Wagtail CMS. It shows that we've successfully installed our Wagtail on our on our local machine so thank you very much for watching And I hope you find this video useful.