save
This commit is contained in:
parent
b0c893dea3
commit
e8ab41e91b
29
README.md
29
README.md
@ -1,9 +1,32 @@
|
|||||||
# OpenSEO
|
# 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.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
- [Why Use This](#why-use-this)
|
||||||
|
- [Main SEO Workflows](#main-seo-workflows)
|
||||||
|
- [Roadmap](#roadmap)
|
||||||
|
- [Pricing / 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)
|
||||||
|
- [Prerequisites](#prerequisites)
|
||||||
|
- [Deploy OpenSEO](#deploy-openseo)
|
||||||
|
- [Local Development](#local-development)
|
||||||
|
- [Prerequisites](#prerequisites-1)
|
||||||
|
- [Run Locally (Quick Test)](#run-locally-quick-test)
|
||||||
|
- [Local Development Workflow (for coding agents)](#local-development-workflow-for-coding-agents)
|
||||||
|
- [Database Commands](#database-commands)
|
||||||
|
- [Contributing](#contributing)
|
||||||
|
- [SEO API Cost Reference](#seo-api-cost-reference)
|
||||||
|
- [Pricing sources](#pricing-sources)
|
||||||
|
- [1) Site audit](#1-site-audit)
|
||||||
|
- [2) Keyword research (`related` mode)](#2-keyword-research-related-mode)
|
||||||
|
- [3) Domain overview](#3-domain-overview)
|
||||||
|
- [Planning examples](#planning-examples)
|
||||||
|
|
||||||
## Why Use This
|
## Why Use This
|
||||||
|
|
||||||
- Open source and self-hostable.
|
- Open source and self-hostable.
|
||||||
@ -60,11 +83,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.
|
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.
|
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
|
### 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.
|
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.
|
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 +108,7 @@ npx everyapp gateway deploy
|
|||||||
```
|
```
|
||||||
|
|
||||||
5. Create an Account
|
5. Create an Account
|
||||||
|
|
||||||
- Follow the link output by the last command to create an account. You will access OpenSEO through this account.
|
- Follow the link output by the last command to create an account. You will access OpenSEO through this account.
|
||||||
|
|
||||||
### Deploy OpenSEO
|
### Deploy OpenSEO
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user