{"id":18756679,"url":"https://github.com/ankitkumar8080/vercel-clone","last_synced_at":"2025-11-30T10:30:13.005Z","repository":{"id":224752442,"uuid":"763200316","full_name":"AnkitKumar8080/vercel-clone","owner":"AnkitKumar8080","description":"This project is designed to automate the react build, deployment, and serving of static websites like on the Vercel platform using Docker containers and BullMQ for task queuing.","archived":false,"fork":false,"pushed_at":"2024-02-27T14:34:58.000Z","size":6024,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-29T02:29:25.973Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AnkitKumar8080.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2024-02-25T20:06:00.000Z","updated_at":"2024-08-23T06:48:57.000Z","dependencies_parsed_at":"2024-02-27T15:56:56.524Z","dependency_job_id":null,"html_url":"https://github.com/AnkitKumar8080/vercel-clone","commit_stats":null,"previous_names":["ankitkumar8080/vercel-clone"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnkitKumar8080%2Fvercel-clone","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnkitKumar8080%2Fvercel-clone/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnkitKumar8080%2Fvercel-clone/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnkitKumar8080%2Fvercel-clone/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AnkitKumar8080","download_url":"https://codeload.github.com/AnkitKumar8080/vercel-clone/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239644077,"owners_count":19673582,"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-07T17:37:38.213Z","updated_at":"2025-11-30T10:30:12.958Z","avatar_url":"https://github.com/AnkitKumar8080.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Project Name: Vercel Deployment Feature Clone\n\n## Overview\n\nThis project is designed to automate the react build, deployment, and serving of static websites like on the Vercel platform using Docker containers and BullMQ for task queuing.\n\n## Architecture\n\n![alt text](./static/arch.png)\n\n### Components\n\n1. **build-server**: A server responsible for building React applications provided through GitHub URLs.\n2. **api-server**: Provides an API endpoint to add GitHub URLs to a Redis queue with BullMQ.\n3. **s3-reverse-proxy**: A reverse proxy server that serves static files from an S3 bucket to the end user.\n\n## Setup\n\n### Prerequisites\n\n- Node.js\n- Docker\n- Docker Compose\n- Redis\n- s3 Bucket\n\n### Installation\n\n1. Clone this repository.\n2. Navigate to the root directory of the project.\n3. Run `docker-compose up` to start all three tiers of the application. (or) you can manually route to each directory and run `npm start`\n\n## Usage\n\n### API Server\n\n- Access the API server via `http://localhost:4001`.\n- To add a GitHub URL to the build queue, send a POST request to `/build` with the following JSON payload:\n  ```json\n  {\n    \"subdomain\": \"example-subdomain\",\n    \"gitUrl\": \"https://github.com/example/repo.git\"\n  }\n  ```\n- A new build job will be added to the queue, and the API server will respond with a message and the URL where the app will be served.\n\n### Build Server\n\n- The build server listens for new jobs on the `build-queue` and processes them.\n- It fetches the GitHub repository and initiates the build process.\n\n### S3 Reverse Proxy\n\n- The S3 reverse proxy serves static files from an S3 bucket.\n- Access static files via `http://subdomain.localhost:4003`.\n\n## Environment Variables\n\nChange the env variables in each of the following 3 - dir\n\n- **REDIS_SERVER_HOST**: Hostname of the Redis server.\n- **REDIS_SERVER_PORT**: Port of the Redis server.\n- **S3_BUCKET_ACCESS_KEY**: Access key for the S3 bucket.\n- **S3_BUCKET_SECRET_KEY**: Secret key for the S3 bucket.\n- **S3_BUCKET_REGION**: Region of the S3 bucket.\n- **S3_ENDPOINT**: Endpoint of the S3 bucket.\n- **PORT**: Port for the API server and S3 reverse proxy.\n\n## Contributing\n\n1. Fork the repository.\n2. Create your feature branch (`git checkout -b feature/fooBar`).\n3. Commit your changes (`git commit -am 'Add some fooBar'`).\n4. Push to the branch (`git push origin feature/fooBar`).\n5. Create a new Pull Request.\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n\n## Acknowledgments\n\n- [BullMQ](https://github.com/taskforcesh/bullmq)\n- [Redis](https://redis.io/)\n- [Docker](https://www.docker.com/)\n- [Node.js](https://nodejs.org/)\n- [Vercel](https://vercel.com/)\n- [OpenAI](https://openai.com/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fankitkumar8080%2Fvercel-clone","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fankitkumar8080%2Fvercel-clone","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fankitkumar8080%2Fvercel-clone/lists"}