Skip to content

WikiLogic/wikilogic.github.io

Repository files navigation

Wikilogic Contributor Docs

The information here is aimed at those interested in the technical side of Wikilogic. For information on why and what Wikilogic it is please refer to www.wikilogicfoundation.org.

Quickstart:

  • Have Docker installed.
  • Clone the Infrastructure repo. Note the command to clone in that repo's readme, it's a bit different than normal. Why? WL is made up from a collection of services, each in their own repo. The Infrastructure repo just containes service configuration and git submodules that pull in the service repos as if they are it's children.
  • Open a command line or the docker terminal (depending on your docker installation) in the project folder (the one you created) and run docker: docker-compose up --build.
  • Have a cup of tea. The first time you do this it'll take a few minutes and might look like it hangs a few times, give it some time - it's doing quite a lot!

Tip - don't close the command line / docker terminal when it's running, if there are errors while you're developing they may show up here.

If that all went well, or even to test if it all went well, try opening the following:


Front end setup

The front end tools run on your local. The code is compiled into a dist directory that is shared with the docker containers.

  • cd into the react-app repo
  • npm install
  • npm start

If you're not comfortable digging into the main codebase, this docs site has it's own repo and wikilogicfoundation.org has a repo for it's WordPress theme. We need help with those areas as well!


ideas:

2 people disagree - make a bet on if something is correct or not - build something around this. Bet against WL?