> For the complete documentation index, see [llms.txt](https://docs.sunflower-land.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sunflower-land.com/contributing/portals-ugc/portal-development.md).

# Portal Development

Are you ready to build your dream portal? Let's get started.

### Run the Project

Run `yarn dev` to spin up the project and navigate to `localhost:3000` in your browser.

{% hint style="warning" %}
Is the normal Sunflower Land game showing? Ensure that you have copied `.env.portal` into `.env`
{% endhint %}

### Boilerplate

The project is currently loading code inside of `PortalApp.tsx`

This app comes preloaded with a basic scene and HUD to demonstrate the foundations. You are able to add, edit & remove code in these files to add the functionality you want.

### What's next?

You can build your portal using whichever web technology your prefer. However, we recommend using existing technologies and patterns in the repository so you don't need to build everything from scratch.

1. [How to Design a Map that players can explore?](/contributing/portals-ugc/phaser-map-design-and-scenes.md)
2. [How to load player data and mint arcade tokens?](/contributing/portals-ugc/portal-apis.md)
3. [How do I deploy my portal so others can play it?](/contributing/portals-ugc/deploying.md)

### Resources

If you are looking to build a portal, it is recommended that you learn the basics of the React framework.

{% embed url="<https://legacy.reactjs.org/tutorial/tutorial.html>" %}

If you are looking to build game mechanics such as Combat, co-op minigames + more advanced functionality, it is recommend you explore the Phaser framework.

{% embed url="<https://phaser.io/>" %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.sunflower-land.com/contributing/portals-ugc/portal-development.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.