admin/metatron-open-seo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #2 from bensenescu/opencode/jolly-moon

Browse Source 
Add TOC to README
This commit is contained in:
Ben Senescu 2026-02-27 15:04:32 -05:00 committed by GitHub
commit 4902bed69c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -1,9 +1,21 @@
# OpenSEO
OpenSEO is an SEO tool for *the people* (non-seo professionals). If tools like Semrush or Ahrefs are too expensive or bloated, OpenSEO is a pay by usage alternative that you actually control.
OpenSEO is an SEO tool for _the people_ (non-seo professionals). If tools like Semrush or Ahrefs are too expensive or bloated, OpenSEO is a pay by usage alternative that you actually control.
![OpenSEO demo (placeholder)](https://placehold.co/1200x675?text=OpenSEO+Demo+GIF+Coming+Soon)
## Table of Contents
- [Why Use This](#why-use-this)
- [Main SEO Workflows](#main-seo-workflows)
- [Roadmap](#roadmap)
- [Pricing / Costs (Free + API costs)](#pricing--costs)
- [DataForSEO API Key Setup \[5 minutes\]](#dataforseo-api-key-setup-5-minutes)
- [Self Hosting (Deploy on Cloudflare) \[5-10 minutes\]](#self-hosting-deploy-on-cloudflare-5-10-minutes)
- [Local Development](#local-development)
- [Contributing](#contributing)
- [SEO API Cost Reference](#seo-api-cost-reference)
## Why Use This
- Open source and self-hostable.
@ -60,11 +72,12 @@ Note: even though the env var is named `DATAFORSEO_API_KEY`, this app sends it a
OpenSEO is built on [Every App](https://github.com/every-app/every-app), a platform for easily self-hosting open source apps like OpenSEO in your own Cloudflare account. Cloudflare enables much more powerful functionality than is possible running on your own computer or on a VPS.
*Windows Users*
_Windows Users_
This has not been tested on Windows. Please let me know if you run into problems. Using WSL will likely work better. Also, try using [fly.io Sprites](https://sprites.dev/) to get a linux sandbox for free if you get totally stuck.
### Prerequisites
If you don't want to make a Cloudflare account yet (its easy!) and just want to test out OpenSEO, skip to the [Run Locally](#seo-api-cost-reference) section.
Note: If you're not comfortable with the terminal or these phrases, ChatGPT or Claude will do a good job coaching you through this.
@ -84,6 +97,7 @@ npx everyapp gateway deploy
```
5. Create an Account
- Follow the link output by the last command to create an account. You will access OpenSEO through this account.
### Deploy OpenSEO