# Ixcanul (Code editor)

Ixcanul is Volcanic's internal code editor used by all developers in the company. Ultimately the code editor is just JS + CSS so any developer (backend/frontend) in the company has the skills to assist in the development.

Instead of keeping the code in the Volcanic source code and allowing only a few backend developers to edit the code, we believe that if we open it to all our developers we can achieve a really powerful tool in a much shorter time.

# How to develop locally?

First you need to make sure you have `node` and `npm` installed.

Then make sure that you're not doing any active development on the master branch by creating a new branch from master

replace `feature-branch` with a purposeful branch name

```bash
git checkout origin/master -B feature-branch
```

then go to the project root directory and run

```bash
npm install
```

When that's done you can start the development server with the command

```bash
npm start
```

now you can go to your browser and visit any ixcanul (code editor) page on the Volcanic Super admin and add to the end of the url

```bash
?local_url=https://localhost:9000
```

When you're done with your feature simply make sure that you commit all changes then do a rebase with the `develop` branch

```bash
git rebase origin/develop
```

Once you're done with the rebase feel free to open a new pull request (PR) and set the `base` branch to `develop`

Happy coding!