candyland-app / candyland-docs

Project-wide documentation & reports

Candyland

⚡️ Backend & frontend designing for the Candyland app

Related

• Docs
• Dependency

Contents

• Related
• Description
• Development
• Team
• License

Description

Building the frontend & backend of the Candyland webapp.

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

Development

Built with Angular and Spring.

• Clone this repository to your local machine
• Navigate to your clone cd candyland-app
• Install the dependencies npm install
• Once done editing your changes check for errors npm test
• Run the development server npm start
• Build Candyland npm run dist
• Cleanup assets & compiled files npm run clean

Team

• Leonidas Avdelas (@LoniasGR) AM: 3113182
• George Baxopoulos (@georgebax) AM: 3113021
• Konstantinos Mitropoulos (@tsikos7) AM: 3113169
• Philippos Orphanoudakis (@PhilOrfan) AM: 3113140
• Klaus Sinani (@klauscfhq) AM: 3113623
• Christos Stilianidis (@Jezulas) AM: 3113130

License

MIT © Candyland team

candyland-docs's Issues

Feature: Integrate building/testing process on Travis-CI

Description

At a glance;

• Add support for travis-ci
• Building process should occur both on Linux & Macos
• Add a building status badge on readme.md

Technical Specifications Report Progess

Report Progress

• PDF builder
• Project dependency
• UML Diagrams
  • Guest user
  • Parent user
  • Provider user
  • Admin user
• Additional UML Diagrams
  • Class Diagram
  • Component Diagram
  • Deployment Diagram
  • Admin user
• ER Diagram
• Use Case Diagrams
  • Platform functionality
  • User management
  • Activities searching
  • User sign-up process
• Wireframes
  • Homepage
  • Sign-up page
  • Sign-in page
  • Admin homepage
  • Admin CRUD
  • Wallet page
  • User profile editing page
  • Event page
  • Event search page
  • Event creation page
  • Provider profile editing page
  • Events history page
  • Event stats report page
  • All events by single provider page

Deployment: Docs Building

Description

• Convert Markdown source files to PDF
• Integrate building process on Travis

Milestone: Requirement Analysis Report

Description

• Finalize the first project report: Requirements Analysis

Feature: Initialize meta-files

Description

Should include the following meta-files;

• package.json
• .editorconfig
• .gitattributes
• .gitignore
• .npmignore
• .npmrc

Deployment: Dependencies checker

Description

• Check for deprecated dependencies while on the testing phase.

Feature: Create Issue/PR templates

Description

Create the following;

• Pull Request template
• Issue template

Feature: Add contributing guidelines & Code-of-Conduct

Description

• Create contributing guidelines
• Add project's Code of Conduct