# How to setup XBlock Development environment on the local machine

**URL:** <https://discuss.openedx.org/t/how-to-setup-xblock-development-environment-on-the-local-machine/13857>\
**Category:** Development\
**Tags:** how-to\
**Created:** [September 5, 2024, 11:14am UTC](https://discuss.openedx.org/t/how-to-setup-xblock-development-environment-on-the-local-machine/13857 "2024-09-05T11:14:35Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![N\_V](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.openedx.org/n_v/32/7090_2.png) [@N\_V](https://discuss.openedx.org/u/N_V)\
**Post date:** [September 5, 2024, 11:14am UTC](https://discuss.openedx.org/t/how-to-setup-xblock-development-environment-on-the-local-machine/13857/1 "2024-09-05T11:14:35Z")

</div>

Hi,

I started to find the possibility of implementing XBlock as plugin for Tutor OpenEdx. I successfully test installing the sample XBlock-poll by following the guideline from [Tutor Doc] ([Configuration and customisation — Tutor documentation](https://docs.tutor.edly.io/configuration.html#installing-extra-xblocks-and-requirements)).

When I tried to setup development environment for XBlock on my local machine, I got problems.

1. There are many documents and I am confused, which one I should follow. ([OpenEdx Doc](https://docs.openedx.org/projects/xblock/en/latest/xblock-tutorial/index.html), [GitHub Doc](https://github.com/openedx/xblock-sdk?tab=readme-ov-file), and [Appsember doc](https://appsembler.com/blog/xblocks-plugins-for-open-edx/#h-developing-custom-xblocks))

2. I firstly follow the instruction from [OpenEdx Doc](https://docs.openedx.org/projects/xblock/en/latest/xblock-tutorial/index.html). After cloning XBlock-SDK from git. I change instruction `make install` to be `pip install -qr requirements\dev.txt`. When I try to create my custom xblock for the first time with this command `(xblock-env) $ xblock-sdk/bin/workbench-make-xblock`. The system cannot recognize `xblock-sdk`.  
And I try to `pip install xblock` and `pip install xblock-sdk `. (both outside the virtual environment and inside the virtual environment), the system cannot recognize the command xblock-sdk.

3. Is it necessary to install `pip install xblock` and `pip install xblock-sdk `?

4. I am window guy, and i found that some of the commands are Linux. Is there any concrete set of instructions to setup XBlock development environment?

Thanks a lot in advance.

---

<div class="post-metadata">

**Author:** ![N\_V](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.openedx.org/n_v/32/7090_2.png) [@N\_V](https://discuss.openedx.org/u/N_V)\
**Post date:** [September 6, 2024, 5:50am UTC](https://discuss.openedx.org/t/how-to-setup-xblock-development-environment-on-the-local-machine/13857/2 "2024-09-06T05:50:58Z")

</div>

Just to update that I follow the steps provided by Braden [https://discuss.openedx.org/t/xblock-sdk-setting-entry-points-for-virtenv/3590/3](https://discuss.openedx.org/t/xblock-sdk-setting-entry-points-for-virtenv/3590/3), and it works.

Here are steps I modify for my window machine:

```auto
C:\git clone git@github.com:edx/xblock-sdk.git
C:\cd xblock-sdk

C:\xblock-sdk>python -m venv venv
(venv) C:\xblock-sdk>.\venv\Scripts\activate

pip install -qr requirements\dev.txt
pip install -qr requirements\local.txt
python manage.py migrate
python manage.py runserver

```