digiops/marketing-parser
2
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Refactor code structure and optimize performance across multiple modules
deploy / deploy (push) Has been cancelled
Details

Browse Source
This commit is contained in:
didar
2026-08-14 16:42:12 +05:00
parent 503eccfb87
commit 8288f9eeb7
2308 changed files with 1185 additions and 180079 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+72 -70
View File
@@ -1,93 +1,95 @@
# marketing-parser
# Marketing Parser
Spring Boot service behind the KonturAI marketing platform. It ingests business news
from RSS sources, runs AI-driven marketing analysis and strategy generation over that
corpus, renders the results as PDF/DOCX/Markdown reports, and publishes campaign
content to social networks.
- **Java 21** · **Spring Boot 3.5.5** · **MongoDB** · **MinIO**
- AI providers: **OpenAI**, **Ollama** (self-hosted), **Google Vertex AI** (Imagen/Veo)
- Deployed via **Gitea Actions** to a self-hosted Docker runner
## Getting started
---
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
## Quick start
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
```bash
# 1. Provide configuration (see docs/configuration.md)
cp .env.example .env
$EDITOR .env # fill in every REQUIRED value
## Add your files
# 2. Supply the Google service-account key (only for image/video generation)
cp /secure/path/google-key.json src/main/resources/keys/google-key.json
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
```
cd existing_repo
git remote add origin https://gitlab.konturai.kz/services/marketing-parser.git
git branch -M main
git push -uf origin main
# 3. Run
set -a && source .env && set +a
./mvnw spring-boot:run
```
## Integrate with your tools
The service listens on `http://localhost:8080`. Interactive API docs are at
`http://localhost:8080/swagger-ui.html`, health at `/api/parser/health`.
- [ ] [Set up project integrations](https://gitlab.konturai.kz/services/marketing-parser/-/settings/integrations)
> The application **fails fast at startup** if a required secret is missing. That is
> deliberate — see [docs/configuration.md](docs/configuration.md).
## Collaborate with your team
## Build and test
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
```bash
./mvnw clean verify # unit tests + JaCoCo coverage gate
./mvnw clean package # build the jar
```
## Test and Deploy
Integration tests boot the full Spring context and need real MongoDB plus the
environment variables above. They are opt-in:
Use the built-in continuous integration in GitLab.
```bash
RUN_INTEGRATION_TESTS=true ./mvnw verify
```
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
`verify` enforces 80% line coverage on `PostingTaskService`, `JwtService` and
`SocialMediaCredentialsService` (see the JaCoCo rule in `pom.xml`).
***
## Documentation
# Editing this README
| Guide | What it covers |
| --- | --- |
| [Architecture](docs/architecture.md) | Modules, request flow, data model, external dependencies |
| [Configuration](docs/configuration.md) | Every environment variable, secret handling, local setup |
| [Deployment](docs/deployment.md) | Gitea Actions pipeline, Docker image, server layout |
| [Development](docs/development.md) | Conventions, testing, adding a parser or endpoint |
| [Troubleshooting](docs/troubleshooting.md) | MongoDB, 401s, common startup failures |
| [API reference](docs/api/README.md) | Per-domain endpoint documentation |
| [RSS parsers](docs/rss-parsers.md) | Sources, scheduling, deduplication |
| [Email reports](docs/email-reports.md) | Sending generated reports by email |
| [Facebook setup](docs/facebook-setup.md) | App, page tokens and lead collection |
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
Historical specs, superseded API revisions and design notes live in
[docs/archive/](docs/archive/README.md).
## Suggestions for a good README
## Repository layout
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
```
src/main/java/kz/konturai/parser/
├── controller/ REST endpoints (15) + GlobalExceptionHandler
├── service/ Business logic (52) — parsers, AI, reports, posting, targeting
├── model/ MongoDB documents (21)
├── dto/ Request/response payloads (68)
├── repository/ Spring Data Mongo repositories (11)
├── config/ Beans, CORS, Swagger, async executors, typed properties
├── validator/ Request validation
├── enums/ Shared enumerations
├── exception/ Domain exceptions
└── util/ Helpers
## Name
Choose a self-explaining name for your project.
deployment/ docker-compose for the production host
docs/ Documentation (see table above)
scripts/ Run helper and smoke-test scripts
.gitea/workflows/ CI/CD pipeline
```
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Security
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
Never commit credentials. All secrets are supplied through environment variables and
`src/main/resources/keys/google-key.json` is deliberately untracked. See
[docs/configuration.md](docs/configuration.md#secret-handling) before adding any new
configuration value.