{"id":19278429,"url":"https://github.com/devjosef/brandveri","last_synced_at":"2025-06-13T17:38:20.738Z","repository":{"id":258140024,"uuid":"866937743","full_name":"Devjosef/Brandveri","owner":"Devjosef","description":"A modern tool for checking trademark and copyright availability. Leverages AI to suggest brand names and integrates with APIs from the EUIPO and USPTO for seamless trademark and copyright verification. Scalable, fast, and reliable.","archived":false,"fork":false,"pushed_at":"2024-10-17T06:06:51.000Z","size":173,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-19T08:28:41.526Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Devjosef.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-03T06:43:23.000Z","updated_at":"2024-10-17T06:06:55.000Z","dependencies_parsed_at":"2024-10-17T20:25:05.959Z","dependency_job_id":"8a5a588c-0ad2-4ebd-8459-aaaccd4477ec","html_url":"https://github.com/Devjosef/Brandveri","commit_stats":null,"previous_names":["devjosef/brandveri"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Devjosef/Brandveri","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Devjosef%2FBrandveri","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Devjosef%2FBrandveri/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Devjosef%2FBrandveri/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Devjosef%2FBrandveri/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Devjosef","download_url":"https://codeload.github.com/Devjosef/Brandveri/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Devjosef%2FBrandveri/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259690362,"owners_count":22896834,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T21:09:33.845Z","updated_at":"2025-06-13T17:38:20.540Z","avatar_url":"https://github.com/Devjosef.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Brandveri \n\nA powerful, AI-driven tool for brand name generation, trademark, and copyright verification. With seamless integration with APIs from the European Union Intellectual Property Office (EUIPO) and United States Patent and Trademark Office (USPTO), Brandveri helps entrepreneurs, startups, and businesses secure their brand identity in real-time.\n\n## Features\n- **AI Brand Name Suggestions**: Generate unique and memorable brand names using OpenAI-powered recommendations.\n- **Trademark \u0026 Copyright Search**: Automatically check trademark and copyright availability via the EUIPO and USPTO APIs.\n- **Real-Time Results**: Instantly verify if a brand name is available for registration.\n- **User Preferences**: Personalize brand name recommendations based on industry, keywords, or target market.\n- **Usage Logs**: Track API usage and performance with detailed logs.\n- **Secure \u0026 Scalable**: Built with scalability and security in mind, ensuring robust performance for growing businesses.\n\n## Table of Contents\n- [Features](#features)\n- [Tech Stack](#tech-stack)\n- [Installation](#installation)\n- [Environment Variables](#environment-variables)\n- [API Endpoints](#api-endpoints)\n- [Caching](#caching)\n- [Load Balancing](#load-balancing)\n- [Continuous Integration \u0026 Deployment](#continuous-integration--deployment)\n- [Testing](#testing)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Tech Stack\n- **Frontend**: React, Tailwind CSS\n- **Backend**: Node.js, TypeScript\n- **Database**: PostgreSQL\n- **Caching**: Redis\n- **Load Balancing**: NGINX\n- **Containerization**: Docker, Kubernetes\n- **CI/CD**: GitHub Actions, Jenkins\n- **External APIs**: EUIPO API, USPTO API\n- **AI Engine**: OpenAI\n\n## Installation\n\n### Prerequisites\n- Node.js (v16+)\n- PostgreSQL\n- Redis\n- Docker \u0026 Kubernetes for containerization\n\n### Step-by-Step Installation\n1. Clone the repository:\n    ```bash\n    git clone https://github.com/yourusername/brandoveri.git\n    cd brandoveri\n    ```\n\n2. Install the dependencies:\n    ```bash\n    npm install\n    ```\n\n3. Set up PostgreSQL and Redis:\n    - Ensure PostgreSQL is running on port 5432 and Redis on port 6379.\n    - Run database migrations (if any):\n        ```bash\n        npm run migrate\n        ```\n\n4. Configure the environment variables by creating a `.env` file:\n    ```bash\n    touch .env\n    ```\n\n5. Fill it with the following values:\n    ```makefile\n    DB_USER=your_db_user\n    DB_PASSWORD=your_db_password\n    DB_HOST=localhost\n    DB_NAME=brandoveriDB\n    DB_PORT=5432\n    REDIS_PORT=6379\n    REDIS_HOST=localhost\n    OPENAI_API_KEY=your_openai_api_key\n    EUIPO_API_KEY=your_euipo_api_key\n    USPTO_API_KEY=your_uspto_api_key\n    ```\n\n6. Start the development server:\n    ```bash\n    npm run dev\n    ```\n    The app will now be running on [http://localhost:3000](http://localhost:3000).\n\n## API Endpoints\n\n### Authentication\n- `POST /api/auth/login` - User login.\n- `POST /api/auth/register` - User registration.\n\n### Brand Name Suggestions\n- `GET /api/brands/suggestions` - Fetch AI-generated brand names.\n  - Query Params: `industry`, `keywords`, `market`\n\n### Trademark Search\n- `POST /api/trademark/search` - Search for trademark availability using EUIPO/USPTO.\n\n### Copyright Search\n- `POST /api/copyright/search` - Search for copyright availability.\n\n### User Preferences\n- `GET /api/user/preferences` - Get user’s saved preferences.\n- `PUT /api/user/preferences` - Update user preferences.\n\n### Logging\n- `GET /api/logs` - Fetch API logs for tracking usage.\n\n## Caching\nBrandveri uses Redis to cache frequently requested trademark and copyright search results. This improves performance and reduces the number of API calls to the EUIPO/USPTO.\n\n## Load Balancing\nNGINX is used for load balancing to ensure that traffic is efficiently distributed across instances of Brandoveri’s backend services, ensuring high availability and reliability.\n\n## Continuous Integration \u0026 Deployment\nBrandveri utilizes GitHub Actions for automated testing, linting, and deployment. Upon pushing code to the main branch, tests are automatically run, and the code is deployed via Jenkins using Docker containers, orchestrated with Kubernetes.\n\n## Testing\nUnit and integration tests are written using Jest and Supertest. You can run the test suite with the following command:\n\n`npm run test` - runs the tests\n\n\n## Contributing\nContributions are welcome! If you’d like to improve Brandoveri, please follow these steps:\n1. Fork the repository.\n2. Create a feature branch (`git checkout -b feature/your-feature-name`).\n3. Commit your changes (`git commit -m 'Add feature'`).\n4. Push to the branch (`git push origin feature/your-feature-name`).\n5. Create a pull request.\n\n## License\nThis project is licensed under the MIT License - see the LICENSE file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevjosef%2Fbrandveri","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevjosef%2Fbrandveri","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevjosef%2Fbrandveri/lists"}