https://github.com/sing1ee/crypto-screener
A modern cryptocurrency screening application built with React and TypeScript, designed to help users track and analyze cryptocurrency market data.
https://github.com/sing1ee/crypto-screener
Last synced: over 1 year ago
JSON representation
A modern cryptocurrency screening application built with React and TypeScript, designed to help users track and analyze cryptocurrency market data.
- Host: GitHub
- URL: https://github.com/sing1ee/crypto-screener
- Owner: sing1ee
- License: mit
- Created: 2024-11-25T13:22:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-25T13:27:51.000Z (over 1 year ago)
- Last Synced: 2025-02-02T10:35:45.089Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 46.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CryptoScreener
A modern cryptocurrency screening application built with React and TypeScript, designed to help users track and analyze cryptocurrency market data.
## Features
- Real-time cryptocurrency market data tracking
- Interactive price charts using Recharts
- Modern UI with Tailwind CSS
- Fully responsive design
- TypeScript for enhanced code reliability
## Tech Stack
- **Frontend Framework:** React 18
- **Language:** TypeScript
- **Styling:** Tailwind CSS
- **Charts:** Recharts
- **Icons:** Lucide React
- **Build Tool:** Vite
- **Code Quality:** ESLint
## Getting Started
### Prerequisites
- Node.js (Latest LTS version recommended)
- npm or yarn
### Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/crypto-screener.git
cd crypto-screener
```
2. Install dependencies:
```bash
npm install
# or
yarn
```
3. Start the development server:
```bash
npm run dev
# or
yarn dev
```
4. Open your browser and visit `http://localhost:5173`
## Available Scripts
- `npm run dev` - Start development server
- `npm run build` - Build for production
- `npm run preview` - Preview production build
- `npm run lint` - Run ESLint
## Project Structure
```
crypto-screener/
├── public/
│ └── favicon.svg
├── src/
│ ├── components/
│ ├── App.tsx
│ └── main.tsx
├── index.html
└── package.json
```
## Contributing
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'feat: add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.