Skip to content

Commit

Permalink
[README] Added config
Browse files Browse the repository at this point in the history
  • Loading branch information
StanGirard committed Jul 1, 2020
1 parent 1144245 commit 1d97328
Showing 1 changed file with 7 additions and 11 deletions.
18 changes: 7 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ I've grown tired of SEO agencies making us pay hundreds of euros for simple tool

- [SEOToolkit](#seotoolkit)
- [Installation](#installation)
- [Running Flask](#running-flask)
- [Running](#running)
- [Dashboard](#dashboard)
- [Config](#config)
- [Endpoints](#endpoints)
- [Graphs](#graphs)
- [Audits](#audits)
Expand Down Expand Up @@ -42,7 +43,7 @@ or you can use Docker
docker build -t seo-toolkit:latest .
```

## Running Flask
## Running

```Bash
flask run
Expand All @@ -54,19 +55,14 @@ or with docker
docker run -d -p 5000:5000 seo-toolkit:latest
```

This will expose these endpoints:
- `localhost:5000/api/graph`
- `localhost:5000/api/extract/headers`
- `localhost:5000/api/extract/links`
- `localhost:5000/api/extract/links/website`
- `localhost:5000/api/serp`
- `localhost:5000/api/analysis/keywords`
- `localhost:5000/api/audit/lighthouse`

## Dashboard

You can access the dashboard by going to `localhost:5000`

## Config

If needed create a `.env` file with information that you would like to overload from config.py


## Endpoints

Expand Down

0 comments on commit 1d97328

Please sign in to comment.