Code Monkey home page Code Monkey logo

miniwikipedia's Introduction

miniWikipedia

miniWikipedia is a summarised version of the whole Wikipedia encyclopedia. It's a lightweight website and it runs in NodeJS and TypeScript.

Manual Installation

To run miniWikipedia locally, you need to have Node.js and npm installed on your machine. You also need to get an API key from Wikipedia to access their data. Follow these steps to set up the project:

  1. Clone this repository to your local machine: git clone https://github.com/aledipa/miniwikipedia.git
  2. Navigate to the project directory: cd miniWikipedia
  3. Install the dependencies: npm install
  4. Build: npm run build
  5. Run the server: node dist/index.js
  6. Open your browser and go to http://localhost:3000 to see the website

Docker Installation

It's possible to install the docker image of miniWikipedia by running this command:

docker container run -p YOUR_PORT:3000 -d d0ckmg/miniwikipedia

or alternatively, you can use a docker-compose file:

docker-compose.yml

version: "3.9"
services:
  node:
    image: d0ckmg/miniwikipedia
    container_name: miniwikipedia
    ports:
      - 3000:3000/tcp

Usage

To use miniWikipedia, simply type a topic in the search box and click the search button or press 'enter'. While typing, below the input bar, will appear a text suggestion, to select it just click on it or press 'tab'.

Contributing

miniWikipedia is an open source project and welcomes contributions from anyone who is interested. If you want to contribute, please follow these guidelines:

  • Fork this repository and create a new branch for your feature or bug fix
  • Write clear and concise code in TypeScript and follow the code style of the project
  • Update the readme.md file if necessary
  • Commit your changes and push them to your forked repository
  • Create a pull request with a descriptive title and message explaining your changes

License

miniWikipedia is licensed under the MIT License. See the LICENSE file for more details.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.