-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
68 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
# NX Content Tracker | ||
|
||
A modern web application for tracking Nintendo Switch content, built with React and TypeScript. | ||
|
||
## Features | ||
|
||
- ๐ฎ Track base games, updates, and DLC content | ||
- ๐ Advanced search with configurable precision | ||
- ๐ Dark/Light theme support | ||
- ๐ฑ Fully responsive design | ||
- ๐ Detailed content information | ||
- ๐ผ๏ธ Screenshot gallery with lightbox | ||
- ๐ Download statistics integration | ||
- ๐ Auto-refresh capabilities | ||
- ๐ฏ Customizable display settings | ||
|
||
## Development | ||
|
||
This project uses: | ||
- Vite for blazing fast development | ||
- React 18 with TypeScript | ||
- Tailwind CSS for styling | ||
- Zustand for state management | ||
- PhotoSwipe for the gallery viewer | ||
|
||
### Getting Started | ||
|
||
```bash | ||
# Install dependencies | ||
npm install | ||
|
||
# Start development server | ||
npm run dev | ||
|
||
# Build for production | ||
npm run build | ||
|
||
# Preview production build | ||
npm run preview | ||
``` | ||
|
||
## Configuration | ||
|
||
The application supports various configuration options through the settings panel: | ||
|
||
- Search precision for names and Title IDs | ||
- Items per page | ||
- Content display limits | ||
- Auto-refresh intervals | ||
- Custom data source URLs | ||
|
||
## Contributing | ||
|
||
1. Fork the repository | ||
2. Create your feature branch (`git checkout -b feature/amazing-feature`) | ||
3. Commit your changes (`git commit -m '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. | ||
|
||
## Acknowledgments | ||
|
||
- Data provided by [nlib.cc](https://nlib.cc) | ||
- Icons by [Lucide](https://lucide.dev) | ||
- Gallery powered by [PhotoSwipe](https://photoswipe.com) |