-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Home
KernelDeimos edited this page Feb 26, 2025
·
9 revisions
Hi, you've found Puter's wiki page on GitHub! If you were looking for
something else, you might find it in the links below.
All of the wiki docs are generated from doc/ directories in the main
repository, so it's best to edit docs there rather than here.
If you have general questions about using Puter, our community Discord and subreddit are good places to ask questions.
- developer.puter.com
- docs.puter.com
- share your apps on Reddit or Discord
Start with Repo Structure and Tooling.
-
Conventions
-
Repo Structure and Tooling
- How directories and files are organized in our GitHub repo
- What tools are used to build parts of Puter
-
Comment Prefixes
- A convention we use for line comments in code
-
Repo Structure and Tooling
This wiki is generated from the repository. Do not edit files the wiki.
You are reading documentation for Puter, an open-source high-level operating system.
Getting started with Puter on localhost is as simple as:
git clone https://github.com/HeyPuter/puter.git
npm install
npm run start- Index (README.md)
- api drivers
- Group Endpoints
- Notification Endpoints
- Share Endpoints
- Type-Tagged Objects
- Comment Prefixes
- contributors vscode
- Local Email Testing
- Puter Extensions
- Repository Structure and Tooling
- Configuring Domains for Self-Hosted Puter
- Configuring Puter
- First Run Issues
- self_hosters config_values
- self_hosters credit_context
- self_hosters support
- Self-Hosting Puter
- Backend Style
- Puter Backend - Directory Structure
- Puter Backend Boot Sequence
- Puter Kernel Moduels and Services
- Index (README.md)
- Configuring AI Services
- PuterAI API Request Examples
- src backend src modules puterai config
####### For Contributors