RepoSniffer

Say goodbye to the hassle of cloning repositories. 🙌 With RepoSniffer, save time, dive into code instantly! 🌐🕵️‍♂️. Wait! there's more to it, it also provides the feature of 1-click deployment directly from your repository.
Explore the docs »

View Demo · Report Bug

About The Project

This is the homepage of the application.

System design of the deployment module

This module contains following services:

• api-server: HTTP API Server for REST API's
• build-server: Docker Image code which clones, builds and pushes the code (after building it) to S3
• s3-reverse-proxy: Reverse Proxy the subdomains and domains to s3 bucket static assets

(back to top)

Built With

• ReactJS - For the UI
• NodeJS - For the backend module
• AWS (ECR & ECS) - For containerization
• Redis - To PUBSUB the deployment logs to redis

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Local Setup

• Fork and clone the Repo

For the frontend module

1. Installing dependencies:

yarn install

Or

npm install

2. Start the Development Mode:

yarn run dev

or if you installed dependencies using npm use below command

npm run dev

3. Create a .env.local file in the repository folder with following parameter
   • Follow this article to get your TOKEN

VITE_GITHUB_TOKEN=''

It runs the app in development mode. Open http://localhost:5173 to view it in your browser.

The page will reload when you make changes.

For the backend module

1. Run npm install in all the 3 services i.e. api-server, build-server and s3-reverse-proxy
2. Docker build the build-server and push the image to AWS ECR.
3. Setup the api-server by providing all the required config such as TASK ARN and CLUSTER arn.
4. Run node index.js in api-server and s3-reverse-proxy
5. Create a .env file in the repository folder with following parameters
   • AWS credentials can be obtained from the AWS console
   • For Redis I have used Aiven

   AWS_ACCESS_KEY_ID=''
   AWS_SECRET_ACCESS_KEY=''
   REDIS_URL=''

At this point following services would be up and running:

S.No	Service	PORT
1	api-server	:9000
2	socket.io-server	:9001
3	s3-reverse-proxy	:8000

(back to top)

Contact

Kshitij Dhawan - [email protected]

Project Link: https://repo-sniffer.netlify.app

(back to top)