Example Template

Contributors Forks Stargazers Issues License

This is a template repository to practice data structures and algorithms.

DISClib · DISClib Demo and Examples · Report Bug · Request Feature

Table of Contents (up to date)

1. Challenge Template
   1. Members
   2. About The Project
      1. Structure
   3. Usage
   4. Contact and support
   5. Contributing
   6. License
   7. Authors and acknowledgment

About The Project

This a repository to practice data structures and algorithms.

IMPORTANT This is a work in progress and is used to teach undergraduate college students. This project Is NOT intended as a full-functional source code project.

Back to top

Structure

The challenge template has four main parts:

1. OLD Root folder with the old version of the template. In here the students can find the old version of code.
2. App Folder with the Logic-View (LV) Python scripts. In here the students implement their code as see fit.
3. Data Folder with CSV data files to load into the application. In here the students add the data files provided by the course staff to complete the challenge.
4. Docs Folder with the reports, data table and other documentation. In here the students add their project report, data tables and other documentation to complement their code implementation.

Back to top

Usage

To use this template, you need to follow the steps below:

• Read the official project document published in the course official site at BrightSpace.
• Distribute the project functionalities and implementation responsibilities between to the group members.
• Download the official dataset for the project at the course official site atBrightSpace.
• Unzip and load the dataset into the application at Data folder.
• Import the necessary modules from DISClib into the MVC scripts at App folder.
• Implement the missing functions according to the project needs in the MVC scripts at App folder.
• Evaluate the implementation of the MVC scripts, record your tests and analysis in the documents at Docs folder (The report MUST BE in PDF format).

Back to top

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this project better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

1. Fork the Project.
2. Create your Feature Branch (git checkout -b feature/AmazingFeature).
3. Commit your Changes (git commit -m 'Add some AmazingFeature').
4. Push to the Branch (git push origin feature/AmazingFeature).
5. Open a Pull Request.

Back to top

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more information go to GNU ORG.

Back to top

Authors and acknowledgment

• Santiago Arteaga is a contributor and repository administrator.

Back to top