Merge pull request #76 from rcos/WebpageReact

Finish NarBar

Assignments/Analysis Homework/AnalysisHomework.tex

@@ -0,0 +1,69 @@
+\documentclass[12pt]{article}
+\usepackage{datetime}
+\usepackage{color,array,graphics}
+\usepackage{enumerate}
+\usepackage[pdftex, colorlinks, linkcolor=red,citecolor=red,urlcolor=blue]{hyperref}
+\usepackage{ulem}
+\usepackage{listings}
+\usepackage{pythonhighlight}
+\usepackage{hyperref}
+
+\newtheorem{theorem}{Theorem}
+\newtheorem{claim}{Claim}
+\newenvironment{solution}{\begin{proof}[Solution]}{\end{proof}}
+\newtheorem{problem}{Problem}
+\newtheorem{exercise}{Exercise}
+
+\setlength{\parindent}{0cm}
+
+\setlength{\parskip}{0.3cm plus4mm minus3mm}
+
+\textwidth  6.5in
+\oddsidemargin +0.0in
+\evensidemargin +0.0in
+\textheight 9.0in
+\topmargin -0.5in
+
+\usepackage{upquote,textcomp}
+\usepackage{amssymb,amsmath,amsfonts,amsthm}
+\usepackage{graphicx}
+\usepackage{multicol}
+\usepackage[T1]{fontenc}
+\usepackage{xcolor}
+\definecolor{textblue}{rgb}{.2,.2,.9}
+\usepackage{mathtools}
+
+
+\begin{document}
+\begin{center}
+\large
+\textbf{CSCI 4470 Open Source Software}\\
+\textbf{Analysis of an Open Source Project}\\
+\textbf{Due date: Month/Day/Year}\\
+\end{center}
+
+In writing this analysis you may want to look at \textit{lab 5} report, particularly the end of the lab 
+where we asked you to look at the license for 5 repositories on the RCOS page. For this assignment, 
+we are going to ask you to take a more in depth look at some open source projects. \\
+
+Pick three projects. You can use projects from \href{https://new.rcos.io}{RCOS}, 
+\href{https://opensource.google/projects/}{Google}, \href{http://foss2serve.org/index.php/HFOSS_Projects}{foss2serve}, 
+or they can be projects you find on your own. At least one of the projects must be outside of RCOS. 
+You are going to write a report on the projects. The report should be in 2 parts. \\
+
+For the first part, start by reading the \href{http://foss2serve.org/index.php/Project_Evaluation_(Activity)}{Project Analysis Activity}
+on the foss2serve website. It walks you through an analysis of an open source project designed 
+to characterize how suitable the project is for a specific class or area of interest. 
+The instructions are specific to the OpenMRS project, but the analysis can be applied to any 
+project. For each of the projects you choose, create a table based on the \href{http://foss2serve.org/index.php/Project_Evaluation_Rubric_(Activity)}{foss2serve rubric}. 
+You must rank each project on every criteria and you must provide supporting evaluation data, 
+but the data can be short. 1 sentence per criteria is fine. \\
+
+Once this initial analysis is complete, pick the project that appeals to you the most and do a 
+more in depth analysis. Expand on the table you generated: add more details to why you scored 
+the project the way you did, discuss what the goal of the project is, discuss the technology 
+used, and discuss the significance of the project. Why is this project appealing? What do you 
+think interacting with this community would be like given the analysis you did? There is no firm 
+length for this assignment, but I anticipate that a good report may be in the range of 3-5 pages. \\
+
+\end{document}

Modules/03.DocumentationAndCommunity/Community.html

@@ -5,7 +5,6 @@
     <meta charset="utf-8">
 
     <title>Community Involvement </title>
-
     <meta name="description" content="Introduction to Documentation">
     <meta name="author" content="Moorthy">
 

WebpageReact/README.md

@@ -0,0 +1,42 @@
+# CSCI-4470 Website
+### Guide written by Andre Lungu ([email protected]) edited by Dyami Watson Jr ([email protected])
+
+This folder contains files for the course website. The website is built using React and was scaffolded using vite.js. As of Spring 2023 (when the website was first created), this website is incomplete, and there are a few issues that need to be addressed before the site can fully go live. As of Spring 2024, Site is ready to go live.
+
+This short guide is intended to outline how the site is organized, for anyone who plans on working on it in the future and who potentially doesn't have a lot of experience with react (like we did, when we initially wrote all this code)
+
+File Structure & Organization
+----------
+The website contains pages for important Open Source Software course information, like the course syllabus, modules, resources, and assignments, as well as an interactive navbar and footer.
+
+This website was built using React, and the files are organized to try and follow React conventions.
+The source code for the website is inside the src folder, which is divided into folders based on file type:
+
+* JSON files, which contain data for course modules, resources, TAs, etc. that are mapped onto some pages
+* Assets (mostly just images)
+* React components 
+* Routes, which are the pages themselves
+* Styles for some of the pages/components
+
+Some of the main files that serve as the base for the site aren't in any specific folder and are just in src.
+
+Running The Site Locally
+----------
+Our project uses vite.js as a tool to run the website on a local server, similar to Visual Studio's Live Server extension for regular html pages.
+Running the site on your end is very easy. Here's what you need to do:
+* Install ubuntu on your laptop 
+* Clone the Open Source Software github repository
+* Install node/npm if you don't already have it
+* Switch to the latest version of node.js using nvm 
+* Navigate to the WebpageReact folder of the repository
+* Type "npm install" and wait for npm to all the packages we have in package.json
+* Type "npm run dev"
+* Open the site using the localhost link on your terminal screen and view the site!
+
+Future Plans/Things To Work On
+----------
+If you want something to work on for the website, you can:
+* Currently all pages are rendering a pdf manually created from the markdown or .rst files. (1) Find a better way to display these or (2) automatically create pdfs on push to repository (potentially using Git actions)
+
+In general, if you are a React expert, feel free to try and improve upon the structure/organization of the site (since we originally created this site with little knowledge of/experience with React). We tried our best to learn how to use React and build the whole website in 1 semester, so if you're coming in to work on this project with prior React experience, you could just try to improve upon what we have.
+

WebpageReact/index.html

@@ -2,10 +2,13 @@
 <html lang="en">
   <head>
     <meta charset="UTF-8" />
-    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <link rel="shortcut icon" type="image/svg+xml" href="../WebpageReact/icons.svg" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Vite + React</title>
+    <title>Open Source Software</title>
+    <link rel="shortcut icon" type="image/png" href="./src/assets/LogoR.png">
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.3.0/css/all.min.css" integrity="sha512-SzlrxWUlpfuzQ+pcUCosxcglQRNAq/DZjVsC0lE40xsADsfeQoEypE+enwcOiGjk/bSuGGKHEyjSoQ1zVisanQ==" crossorigin="anonymous" referrerpolicy="no-referrer" /> 
   </head>
+
   <body>
     <div id="root"></div>
     <script type="module" src="/src/main.jsx"></script>