wikimore/README.md
Kumi c436885cbc
feat: initial setup of Wikimore Flask app with basic features
Added initial setup for "Wikimore", a simple frontend for Wikimedia projects using Flask. The app includes the following features:

- Multi-language and multi-project support
- Search functionality with results displayed
- Proxy support for Wikimedia images
- Basic structure and templates (home, article, search results)

Configured appropriate .gitignore and .vscode settings for development. Licensed under MIT License.
2024-07-11 12:25:19 +02:00

27 lines
1.2 KiB
Markdown

# Wikimore - A simple frontend for Wikimedia projects
Wikimore is a simple frontend for Wikimedia projects. It uses the MediaWiki API to fetch data from Wikimedia projects and display it in a user-friendly way. It is built using Flask.
This project is still in development and more features will be added in the future. It is useful for anyone who wants to access Wikimedia projects with a more basic frontend, or to provide access to Wikimedia projects to users who cannot access them directly, for example due to state censorship.
## Features
- Multi-language support (currently English and German, more can and will be added)
- Multi-project support (currently Wikipedia and Wiktionary, more can and will be added)
- Search functionality
- Proxy support for Wikimedia images
## Installation
1. Clone the repository
2. Install the required packages using `pip install -r requirements.txt`
3. Run the app using `python app.py`
## Usage
1. Open your browser and navigate to `http://localhost:5000`
2. Use the search bar to search for articles on a given Wikimedia project, in a given language
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.