Git Product home page Git Product logo

mvn-documentator's Introduction

MVN Documentator

alt text

Въведение

Целта на системата е да автоматизира и улесни процеса по създаване на документация на софтуерни проекти, като включва полезна информация за тях, представена нагледно и в удобен за четене вид. Потребителите прикачват информация за желаните от тях проекти в лесен за представяне формат и избират стил на документацията според предпочитанията си от няколко предефинирани темплейта. В резултат се генерира сайт с подадената информация и според избрания дизайн. Системата е предназначена за всички страни, включени в процеса на софтуерна разработка.

Инсталация и настройки

Машината, на която се пуска системата, трябва да има инсталирани:

  • Maven
  • XAMPP, MySQL

При първоначално стартиране на приложението, се изпълнява автоматично SQL скрипт, който създава необходимата база данни, таблици и полета. Съответно при всяко следващо стартиране на системата, се прави проверка дали базата данни и таблиците съществуват и само ако не съществуват се създават отново.

Технологии

  • Front-end: HTML, CSS, JavaScript
  • Back-end: PHP, Maven
  • Database: MySQL

Входни данни

Данните, които системата приема, са във формат CSV. В CSV файла се описва информацията за проекта и участниците в него. За да предостави гъвкавост на потребителя, системата позволява включването на данни за неограничен брой участници.

Съдържание на документацията

Проекти:

  • Номер и заглавие на проекта
  • Описание
  • Ресурси – препоръчани и използвани
  • GitHub линк
  • Информация за презентиране: дата, час, линк към BBB

Участници (неограничен брой)

  • Име
  • Фамилия
  • Специалност
  • Курс
  • Факултетен номер
  • Разпределение на задачите
  • Време за работа по проекта (човекочаса)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.