Skip to content

Commit

Permalink
Merge pull request #39 from guilyx/fix-badges
Browse files Browse the repository at this point in the history
Fix badges
  • Loading branch information
guilyx committed Sep 4, 2023
2 parents cf83501 + ac334fb commit 03f2cb6
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 13 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# TrackDrop
![CI/CD](https://github.com/guilyx/trackdrop/workflows/deploy/badge.svg)
[![build](https://github.com/guilyx/TrackDrop/actions/workflows/build.yml/badge.svg)](https://github.com/guilyx/TrackDrop/actions/workflows/build.yml)
![vercel](https://vercelbadge.vercel.app/api/guilyx/trackdrop)
[![codecov](https://codecov.io/gh/guilyx/trackdrop/branch/master/graph/badge.svg)](https://codecov.io/gh/guilyx/trackdrop)
![License](https://img.shields.io/github/license/guilyx/trackdrop)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Track your wallet's interactions on chains/protocols that will potentially airdrop their tokens. TrackDrop is a fork from `zkFlow`.

Expand All @@ -15,9 +16,9 @@ Track your wallet's interactions on chains/protocols that will potentially airdr

To get `TrackDrop` up and running locally on your machine, follow these steps:

### Running the TxTracker Docker Container
### Running the TrackDrop Docker Container

The TxTracker Docker container allows you to run the application in an isolated environment.
The TrackDrop Docker container allows you to run the application in an isolated environment.
Follow these steps to build and run the Docker container:

### Prerequisites
Expand Down Expand Up @@ -46,7 +47,7 @@ Before you begin, make sure you have the following software installed on your sy
docker-compose -f docker/docker-compose.yml build
```

This command will use the `Dockerfile` located in the `docker` directory to build the Docker image named `txtracker`.
This command will use the `Dockerfile` located in the `docker` directory to build the Docker image named `trackdrop`.

### Run the Docker Container

Expand All @@ -56,32 +57,30 @@ Before you begin, make sure you have the following software installed on your sy
docker-compose -f docker/docker-compose.yml up
```

2. Once the container is up and running, you can access the TxTracker application by opening a web browser and navigating to `http://localhost:5173/tx-tracker`.
2. Once the container is up and running, you can access the TrackDrop application by opening a web browser and navigating to `http://localhost:5173`.

### Stopping and Removing the Container

When you're done using the TxTracker application, you can stop and remove the Docker container:
When you're done using the TrackDrop application, you can stop and remove the Docker container:

1. Run the following command to stop and remove the Docker container:

```bash
docker-compose -f docker/docker-compose.yml down
```

2. Open your browser and navigate to `http://localhost:5173` to view the TrackDrop web app.

### Additional Notes

- If you want to make changes to the application code, you can do so in your local project directory, and the changes will be reflected in the running Docker container.
- The Docker container exposes the application on port 8080. You can modify the `docker-compose.yml` file to change the port mapping if needed.

---

With these instructions, you should be able to build and run the TxTracker Docker container on your system. If you encounter any issues, refer to the Docker documentation or seek assistance from your development team.
With these instructions, you should be able to build and run the TrackDrop Docker container on your system. If you encounter any issues, refer to the Docker documentation or seek assistance from your development team.

## Disclaimer

I am not a web developer, and have heavily based what I did on `zkFlow`. Credit goes to them for the squeletton and design of the web app.
I am not a web developer, and have heavily based what I did on `zkFlow`. Credit goes to them for the squeletton and design premises of the web app.

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion docker/docker-compose.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: '3.8'

services:
txTracker:
Trackdrop:
image: node:18-alpine
build:
context: ..
Expand Down
11 changes: 11 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
"@fortawesome/free-regular-svg-icons": "^6.4.0",
"@fortawesome/free-solid-svg-icons": "^6.4.0",
"@fortawesome/react-fontawesome": "^0.2.0",
"@vercel/analytics": "^1.0.2",
"axios": "^1.4.0",
"cli": "^1.0.1",
"ethers": "^5.7.2",
Expand Down
1 change: 1 addition & 0 deletions src/App.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import HomePage from './pages/HomePage.tsx';
import AddressPage from './pages/AddressPage.tsx';


const App = () => {
return (
<main className="absolute top-0 left-0 w-full min-h-full bg-gray-100 dark:bg-gray-900">
Expand Down
4 changes: 3 additions & 1 deletion src/main.tsx
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
import React from 'react';
import ReactDOM from 'react-dom/client';
import { Analytics } from '@vercel/analytics/react';
import App from './App.tsx';
import './index.css';

ReactDOM.createRoot(document.getElementById('root') as HTMLElement).render(
<React.StrictMode>
<App />
<Analytics />
</React.StrictMode>,
);
);

0 comments on commit 03f2cb6

Please sign in to comment.