for contributors setup)

WikiLogic 0.4: Ferret

Front End: RestRucturing EveryThing

Getting set up

You'll need these already installed:

Node.js
MongoDB
Browserify
Gulp 4 npm install -g gulpjs/gulp.git#4.0 npm install -g jshint

Then you can pull in WikiLogic:

git clone https://github.com/WikiLogic/WikiLogic.git
npm install
npm start This will just run the server. TODO: hook up to the remote db when this command is run.
npm run start:dev This will run EVERYTHNIG locally, don't be afraid if your terminal goes nuts, there's a lot happening in there.

Alternative setup with Docker

With Docker and Docker Compose, you won't need to install MongoDB and the dependencies manually.

Just execute the following commands:

docker-compose build
docker-compose up

Open your browser and go to http://localhost:3000 to see the application. You can also connect to your MongoDB on localhost:27017 (e.g. with RoboMongo).

Notes:

The node_modules directory is “inside” the Docker container, so you won't see it on your host machine.
This has only been tested with Docker for Mac. URLs can change under Linux or Windows.

What's where?

`/server`

This is the Express app, job 1: serve the static assets. job 2: serve the data. In future versions these two jobs will be split.

`/static`

This holds the JS and CSS for the web app. Do not do any development in here, your work will be overwritten by compilers.

`/staticSrc`

This hold the es6 / sass files that will be compiled down into the static folder. This is where any Front End Devs will live.

`/test`

This is the code that will test everything. When you push / pullrequest to our github repo, travis will run these tests and only accept the branch / commit if the tests pass.

How does it run?

Clientside we're using Rivets.js to bind data to the DOM and browserify to deal with the JS that manages that data.
Serverside we're using Express.js to serve the site.
For the database we're using MongoDB.

DB cheatsheet for development

see user profile: db.users.find({"local.email":"email here"}).pretty()

remove drafts from user profile: db.users.update({"local.email":"email here"},{$set:{"meta.unPublished":[ ]}}) db.users.update({"local.email":"email here"},{$set:{"meta.published":[ ]}})

clear out claims: db.claims.remove({"status":false}) / true

clear out drafts