|
1 | 1 | # Arkeo Airdrop Frontend
|
2 | 2 |
|
3 |
| -This is the repo containing the frontend for the Arkeo Airdrop |
| 3 | + |
| 4 | +## Description |
| 5 | + |
| 6 | +This project is a React frontend application that provides a user interface for the Arkeo Airdrop. |
| 7 | + |
| 8 | +## Prerequisites |
| 9 | + |
| 10 | +- Node.js 18 or higher |
| 11 | +- Yarn package manager |
| 12 | +- Docker and Docker Compose (for containerized deployment) |
| 13 | + |
| 14 | +## Local Development |
| 15 | + |
| 16 | +1. Clone the repository: |
| 17 | + |
| 18 | + ```bash |
| 19 | + git clone <repository-url> |
| 20 | + cd arkeo-airdrop-frontend |
| 21 | + ``` |
| 22 | + |
| 23 | +2. Install dependencies: |
| 24 | + |
| 25 | + ```bash |
| 26 | + yarn install |
| 27 | + ``` |
| 28 | + |
| 29 | +3. Create a `.env` file based on the `.env.example`: |
| 30 | + |
| 31 | + ```bash |
| 32 | + cp .env.example .env |
| 33 | + ``` |
| 34 | + |
| 35 | +4. Start the development server: |
| 36 | + |
| 37 | + ```bash |
| 38 | + yarn dev |
| 39 | + ``` |
| 40 | + |
| 41 | +5. Access the application at `http://localhost:5173` (or the port shown in your terminal) |
| 42 | + |
| 43 | +## Environment Variables |
| 44 | + |
| 45 | +Configure these variables in your `.env` file: |
| 46 | + |
| 47 | +| Variable | Description | |
| 48 | +| ------------------------ | ------------------------------------------ | |
| 49 | +| VITE_WALLET_CONNECT_ID | WalletConnect project ID | |
| 50 | +| VITE_ARKEO_ENDPOINT_REST | Arkeo REST API endpoint | |
| 51 | +| VITE_ARKEO_ENDPOINT_RPC | Arkeo RPC endpoint | |
| 52 | +| VITE_THORCHAIN_SERVER | THORChain server URL | |
| 53 | +| VITE_IS_TESTNET | Set to true for testnet, false for mainnet | |
| 54 | + |
| 55 | +## Building for Production |
| 56 | + |
| 57 | +To build the application for production: |
| 58 | + |
| 59 | +```bash |
| 60 | +yarn build |
| 61 | +``` |
| 62 | + |
| 63 | +The built files will be in the `dist` directory, ready to be served by a web server. |
| 64 | + |
| 65 | +## Docker Deployment |
| 66 | + |
| 67 | +### Using Docker Compose (Recommended) |
| 68 | + |
| 69 | +1. Make sure Docker and Docker Compose are installed on your system |
| 70 | +2. Configure your environment variables in `.env` |
| 71 | +3. Build and start the container: |
| 72 | + ```bash |
| 73 | + docker-compose up -d |
| 74 | + ``` |
| 75 | +4. Access the application at `http://localhost:3000` |
| 76 | + |
| 77 | +### Using Docker Directly |
| 78 | + |
| 79 | +1. Build the Docker image: |
| 80 | + |
| 81 | + ```bash |
| 82 | + docker build -t arkeo-airdrop-frontend . |
| 83 | + ``` |
| 84 | + |
| 85 | +2. Run the container: |
| 86 | + |
| 87 | + ```bash |
| 88 | + docker run -p 3000:80 --env-file .env arkeo-airdrop-frontend |
| 89 | + ``` |
| 90 | + |
| 91 | +3. Access the application at `http://localhost:3000` |
| 92 | + |
| 93 | +## Project Structure |
| 94 | + |
| 95 | +``` |
| 96 | +arkeo-airdrop-frontend/ |
| 97 | +├── src/ # Source code |
| 98 | +├── public/ # Static assets |
| 99 | +├── dist/ # Built application (after build) |
| 100 | +├── node_modules/ # Dependencies |
| 101 | +├── Dockerfile # Docker configuration |
| 102 | +├── nginx.conf # Nginx configuration for production |
| 103 | +├── docker-compose.yml # Docker Compose configuration |
| 104 | +├── vite.config.js # Vite configuration |
| 105 | +├── package.json # Project dependencies and scripts |
| 106 | +└── .env # Environment variables (not committed to git) |
| 107 | +``` |
| 108 | + |
| 109 | +## Scripts |
| 110 | + |
| 111 | +- `yarn dev`: Start development server |
| 112 | +- `yarn build`: Build for production |
| 113 | +- `yarn lint`: Run linter |
| 114 | +- `yarn preview`: Preview production build locally |
| 115 | + |
| 116 | +## License |
| 117 | + |
| 118 | +MIT |
| 119 | + |
0 commit comments