Skip to content

candyland-app/candyland-docs

Repository files navigation


Candyland Docs

📝 Project-wide documentation & reports

Build Status Dependency Status XO code style Remark md style

Related

Contents

Description

Building and maintaining project-wide documentation and reports for the Candyland app.

The Candyland webapp is the semester-long team project for the 2017 Software Engineering course at ECE NTUA.

Building

  • Install the dependencies npm install
  • Start the PDF-building server npm start
  • Once done editing check for errors npm test
  • Build the reports npm run dist
  • Package the artifacts npm run pack
  • Clean-up compiled files npm run clean

Project-wide docs and reports linting for markdown syntax errors is done using remark-cli.

Team

License

MIT © Candyland team