Welcome to Plani-Wiki

Instructions to run and test:

• git clone https://github.com/flpsan/plani-wiki.git
• cd plani-wiki
• npm install
• npm start
• Done! SPA should be listening at localhost:8080 and the API at localhost:9090
  • Examples for API endpoints:
    • curl http://localhost:9090/articles/ to list articles
    • curl -X PUT http://localhost:9090/articles/article1 -d "New article content" to create or update an article named article1
    • curl http://localhost:9090/articles/article1 to get article1 content
• To test the API: npm test

Technologies and APIs used:

• Node.js to provide full back-end funcionality
• Fetch API to make http requests
• Bootstrap as front-end framework
• showdown.js to convert plain text on Markdown notation to HTML
• concurrently.js to provide cross-plataform solution for multiple npm start commands
• Mocha and Chai for tests

Yet to do:

• Test invalid Markdown