|
5 | 5 |  |
6 | 6 |  |
7 | 7 |  |
| 8 | + |
8 | 9 |
|
| 10 | +OpenModelDB is a community-driven database of AI upscaling models. We provide a centralized place to discover, compare, and download image/video upscaling models with detailed metadata, example images, and architecture information. |
9 | 11 |
|
10 | | -This repo contains all models and model metadata for OpenModelDB. |
| 12 | +## Features |
11 | 13 |
|
12 | | -OpenModelDB is a community-driven database of AI Upscaling models. We aim to provide a better way to find and compare models than existing sources. |
| 14 | +- Browse 600+ AI upscaling models with detailed information |
| 15 | +- Compare models side-by-side with example images |
| 16 | +- Filter by architecture, scale, tags, and more |
| 17 | +- View model metadata including training details and licenses |
| 18 | +- Download models from various sources |
13 | 19 |
|
| 20 | +## Getting Started |
| 21 | + |
| 22 | +### Prerequisites |
| 23 | + |
| 24 | +- [Git](https://git-scm.com/downloads) |
| 25 | +- [Node.js](https://nodejs.org/) >= 18.17.0 |
| 26 | + |
| 27 | +### Installation |
| 28 | + |
| 29 | +```bash |
| 30 | +# Clone the repository |
| 31 | +git clone https://github.com/OpenModelDB/open-model-database.git |
| 32 | +cd open-model-database |
| 33 | + |
| 34 | +# Install dependencies |
| 35 | +npm ci |
| 36 | + |
| 37 | +# Start the development server |
| 38 | +npm run dev |
| 39 | +``` |
| 40 | + |
| 41 | +The site will be available at http://localhost:3010. |
| 42 | + |
| 43 | +## Contributing |
| 44 | + |
| 45 | +We welcome contributions! Here are some ways you can help: |
| 46 | + |
| 47 | +- **Add models**: Submit new AI upscaling models to the database |
| 48 | +- **Report bugs**: Open an issue if you find a problem |
| 49 | +- **Suggest features**: Share ideas for improvements |
| 50 | +- **Improve documentation**: Help make the docs better |
| 51 | + |
| 52 | +See our [Contributing Guide](https://openmodeldb.info/docs/contributing) for detailed instructions on how to: |
| 53 | +- Add new models via the web interface |
| 54 | +- Set up a local development environment |
| 55 | +- Submit pull requests |
| 56 | + |
| 57 | +## Tech Stack |
| 58 | + |
| 59 | +- [React](https://react.dev/) - UI framework |
| 60 | +- [Next.js](https://nextjs.org/) - Static site generation |
| 61 | +- [Tailwind CSS](https://tailwindcss.com/) - Styling |
| 62 | +- [TypeScript](https://www.typescriptlang.org/) - Type safety |
| 63 | + |
| 64 | +## License |
| 65 | + |
| 66 | +This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details. |
| 67 | + |
| 68 | +## Links |
| 69 | + |
| 70 | +- [Website](https://openmodeldb.info/) |
| 71 | +- [FAQ](https://openmodeldb.info/docs/faq) |
| 72 | +- [Discord](https://discord.gg/enhance-everything-547949405949657098) |
0 commit comments