Skip to content

Repository for The Wiki Factory team (wikimini-b) for deploy(impact) 2022

License

Notifications You must be signed in to change notification settings

WomenPlusPlus/deploy-impact-22-wikimini-b

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wikimini - by The Wiki Factory

This repository is the base for our vision of what Wikimini, the encyclopedia for kids, could be like in the future. Follow the instructions below it to install and run it on your local machine. Documentation can be found in the docs folder, our source code can be found in scr/node-backend and src/angular-frontend, and the designs are behind the links included below. We also want to thank all the great people who make their libraries publicly usable whose code we used which are mentioned here.

Contact

Please contact Ewa Magdoń at ewa.magdon@protonmail.com for any questions.

Designs

The designs were created using Figma, you can find them here.

Local installation using XAMPP

Install and run MediaWiki

  • The instructions to install MediaWiki on XAMPP are here
  • Install XAMPP on your PC: download the installer for your operating system here
  • Follow the instructions on the MediaWiki manual for the following steps:
    • Getting Apache and MySQL running
    • Creating your database
    • Editing PHP.ini
      • you should also look for "intl" in the php.ini file and uncomment the intl extension line (remove the ;), and then restart the server
    • Setting up MediaWiki
  • after finishing the setup, add the code from the file docs/Additions to LocalSettings.php to your LocalSettings.php file and restart the XAMPP services

Installing Node.js & npm

  • go to: https://nodejs.org/en/download/ and click on your operating system option
  • follow installation wizard
    • no need to install "tools for native modules" once you get to that screen in wizard
  • once done, open your terminal and write "node -v" and "npm -v", you should see on your screen the versions

Run Wikimini

  • Install an IDE; e.g. VSCode
  • You need node.js and npm installed
  • Clone the repository on your PC (instructions on how to do are e.g. here), e.g. using the inbuilt vscode GIT functionalities

Set up the database

  • create a new MariaDb database using the MariaDb instance from XAMPP, by default in the project code it is called factorydb
  • import the sql file that is provided in /docs to set up the database and fill it with some test data

Running The App

  • open bash terminal and cd src/angular-frontend && npm i && cd ../node-backend && npm i to install any missing node modules
  • to start frontend, run npm start in angular-frontend directory
  • to start backendend, run npm start in node-backend directory, and click on "start" Apache and MySQL services in XAMPP control panel

About

Repository for The Wiki Factory team (wikimini-b) for deploy(impact) 2022

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published