24dev-demo Software Digital Portfolio
An unofficial OSGeo addon to demonstrate and showcase your Software Portfolio via github.com.
This software is intended to provide users with an open source ecosystem to develop, test drive and share applications alongside the Linux OSGeo Live project. Developers, students and prospective employers will benefit by viewing the user's project code and summary on Github then verifing the applications on OSGeo. The "24dev" name is a play on words for: "Two For DEVelopment", via the open source community and developer. Minimal prerequisites include familiarity with the Linux operating system and Bash Shell scripting.
24dev High Level Use Cases
The 24dev process involves 3 Use Case Actors: student, teacher and employer. The list below describes how the 24dev system should interact with these users:
- As a student, I would like to learn marketable CS or IT skills which can be accessed online by teachers and potential employers.
- As a teacher, I would like my students to learn marketable CS or IT skills and showcase them on github.
- As an employer, I would like to hire CS or IT employees with an impressive online portfolio where I can view code, documentation and test drive applications.
- Users can install 24dev applications to a live OSGeo DVD, flash drive or virtual machine by running one administrative installation script.
- Users can re-run the install script to update profiles, and accept different 24dev-* programs.
The install script also creates a backup and purges application log files.
- Users can test their programs with the regressionTester application and have statistics and Pass/Fail results published to the: Project-Sumary.md.
- Scripts can display applicable license and README.md files.
- All user applications are expected to have a bin, docs, logs, output and output/goodtests folders/files.
- Users can optionally include a verification screenshot of their 24dev program and github account.
- Users are encouraged to create their own customized releases via github renamed as: 24dev-[myForkName].
Installing 24dev-demo to an OSGeo-Live system
- Boot your computer with the OSGeo Live DVD. Or see OSGeo-Live Quick Start for other options.
- Download the latest version of the 24dev-demo release tar file.
- Copy the tar file to the OSGeo Desktop.
- Right click on the tar file and select "Extact Here".
- Navigate into the extracted folder, open a terminal window there and run the following commands:
chmod -R 755 *; cd 24dev-demo; ./install.sh
- The above command sets up the environment and runs the installation script which requires an Internet connection to install external programs.
- The 24dev program is documented online at: https://github.com/pmcgover/24dev-demo
Using 24dev-demo on OSGeo
- Install the 24dev application on OSGeo, open a new terminal window and type "alias" to view the custom 24dev-demo commands.
- Enter the "apps" alias and browse through the available applications.
- Note that each application has a similar folder structure for programs (bin), input/ouput files, logs, docs, etc.
- Update and preview your ".md" markdown files with the "retext" program.
- Use the "mdrme" alias to view/update your main project README.md file.
- Run the regresson test process via the "runrt" alias to verify programs and initiate the database.
- Navigate to the desired apps doc folder and view the related docs/README-<appName>.md file.
- Navigate to the desired apps bin folder and execute the program per the documentation.
- View .csv files with the csvtool application via the alias "mycsv <fileName.csv> |view -"
Creating your own 24dev Software Digital Portfolio
- Learn about git and github: Github Help
- Open a free github account: Github Account Signup
- Fork the 24dev-demo repository then clone to your computer: Fork A Repo
- Rename the new repo as needed (e.g. mv 24dev-demo 24dev-<yourUserName> )
- Update your new 24dev instance with your applications, custom settings, documentation and license.
- If using the MIT license, append your copyright details below existing copyright entries. See example below:
Original work Copyright (c) 2015 Patrick Noel McGovern Modified <appName>, Added <appName> Copyright 2016 Mary Carol Doe
- Install, run and test your applications on a live OSGeo DVD, flash drive or virtual machine.
- Run the install script to clean up the 24dev file system. Perhaps retain the last backup tar file.
- Optionally include a verification screenshot of your 24dev program and github account. See README-install2Osgeo.md
- Copy/push your changes to your local github repository or see: Working with remote git repositories
- Below are commands to commit your changes:
- Navigate to your local git working directory.
- Add your new changes: git add -A
- Commit your changes: git commit -m 'Updated the ABC application'
- Push your changes to the remote repository: git push origin
- Create tags and releases to mark important change sets and push them to github: git tag v.N.N.N; git push --tags origin
- Rinse and Repeat: Navigate to your github remote repository, download the most recent tagged release and deploy/test on OSGeo.
- Update your resume with a link to your github 24dev repository.