https://github.com/edbert-fl/unihack-2025
https://github.com/edbert-fl/unihack-2025
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/edbert-fl/unihack-2025
- Owner: edbert-fl
- Created: 2025-03-14T08:08:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-14T11:02:42.000Z (over 1 year ago)
- Last Synced: 2025-03-14T11:21:36.715Z (over 1 year ago)
- Language: TypeScript
- Size: 65.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# **Cryptarity** 
Welcome to **Cryptarity** app—a web application designed to track cryptocurrency donations in real-time, showcasing their positive impact on global communities. With an elegant, modern design and interactive features, you can contribute to charitable causes using cryptocurrency and witness the real-world difference your donations are making!
## 🚀 Features
- **Real-Time Cryptocurrency Donations**: Instantly track your cryptocurrency donations as they happen.
- **Impact Dashboard**: Get detailed metrics and statistics on how your donations are being utilized.
- **Smooth Animations**: Enjoy an engaging, interactive UI with smooth animations powered by [Framer Motion](https://www.framer.com/motion/).
- **Modern Design**: A clean, responsive design built with [Tailwind CSS](https://tailwindcss.com/).
## 🛠 Technologies Used
- **React**: The powerful frontend framework that drives our app.
- **Framer Motion**: For sleek animations and seamless transitions.
- **Tailwind CSS**: Utility-first CSS styling for quick and easy customization.
- **React Icons**: Customizable icons to enhance the user experience.
- **TypeScript**: A robust, type-safe development experience for scaling the project.
## 🌐 Website Live on Vercel
Exciting news! Our website is live on Vercel! Check it out and explore the app at [unihack-2025.vercel.app](https://unihack-2025.vercel.app).
## 🛠 Setup & Installation
Get started with your own local development setup by following these simple steps!
### Prerequisites
- **Node.js** (v16 or later)
- **npm** or **yarn** (your preferred package manager)
### 1. Clone the Repository
Clone the project repository to your local machine.
```bash
git clone https://github.com/edbert-fl/unihack-2025.git
cd unihack-2025/git
```
### 2. Install Dependencies
Install all the project dependencies using your preferred package manager.
```bash
npm install
```
or
```bash
yarn install
```
### 3. Run the Development Server
To run the app locally, execute the command to start the development server. Your app will be available at [http://localhost:3000](http://localhost:3000).
```bash
npm run dev
```
or
```bash
yarn dev
```
### 4. Set Up Environment Variables
Create a `.env.local` file in the root of your project and add the necessary environment variables as provided in the documentation.
```bash
ASTRADB_TOKEN=
ASTRADB_ENDPOINT=
SERPAPI_API_KEY=
```
## 🤝 Contributing
We welcome contributions to this project! If you’d like to help improve it, please follow these simple steps:
1. **Fork the repository**
2. **Create a feature branch**
3. **Commit your changes**
4. **Push your branch to your forked repository**
5. **Submit a pull request to the main branch**
Your contributions are always appreciated!
## 📞 Contact
Have questions or suggestions? Feel free to reach out to us! You can contact us on Github.
---
We hope you enjoy the app and that it makes a meaningful difference in the world! 💚