https://github.com/telexintegrations/site-analysis-agent
https://github.com/telexintegrations/site-analysis-agent
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/telexintegrations/site-analysis-agent
- Owner: telexintegrations
- Created: 2025-03-11T16:07:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-20T14:08:19.000Z (over 1 year ago)
- Last Synced: 2025-03-20T15:23:25.416Z (over 1 year ago)
- Language: Java
- Size: 128 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SITE ANALYSIS AGENT
## Project Description
The site analysis agent is a springboot application that allows users to optimize their site for SEO.
It uses telex channels to send an SEO report after a user inputs their site url.
The analysis is done by AI which will generate a comprehensive report that the user can work on to improve their sites ranking.
The project requirements documnet can be found [here](https://docs.google.com/document/d/1ntX5bdiA9kbPYFyxjM9_J97kJfPmHpY-rQBlea85qnE/edit?addon_store&tab=t.0)
## Project Structure
The project is broken down as follows:
>>Utils
>>dto
>>Controller
>>Service
## Contribution Guideline
- Clone the repo by writing the command below in your favourite code editor
\
```https://github.com/telexintegrations/site-analysis-agent.git```
\
- Build the project: `mvn clean package`
- Change your branch to the one you want to work with following [Branch Naming convention](https://github.com/naming-convention/naming-convention-guides/blob/master/git/branch-naming.md)
- Make your changes according following the [App Architecture](#Project-Structure)
- Commit your changes following [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
- Push your branch
- Make your Pull Request to `main` and add a reviewer to merge your Pull Request
## NB:
**You should never commit your changes directly to the main branch**
## Getting started
1. Clone the repository:
`git clone https://github.com/your-username/spring-sample.git`
2. Build the project: `mvn clean package`
3. Run the application: `java -jar target/spring-sample.jar`
4. Access the application at http://localhost:8080