zackarysantana / webwisdom Goto Github PK

0.0 2.0 0.0 460 KB

JavaScript 15.08% Astro 42.01% TypeScript 24.79% Svelte 2.99% Dockerfile 11.47% Vue 3.66%

webwisdom's Introduction

WebWisdom

Contributing

All contributions will be made via the PR tab! Create a branch/fork, code your solution, link the supporting issue that the PR is for, and then make the PR on the GitHub tab.

Runtime/Tools (Recommended version):

Required

Node v19.3.0
NPM v9.2.0 (Comes with Node)

Not required

NVM Windows v1.1.9 (Project Management)
NVM Linux v0.39.1 (Project Management)
Docker v20.10.16 (Deployment)
Flyctl (Deployment)

Technologies:

Frontend:

Astro - Main Framework
TypeScript - Main language
Additional:
- React
- Preact
- Svelte
- Solid
- Lit
- Alpine

Backend:

Astro - Main Framework

Deployment

Docker - To make stable and reliable VM's for deployment
Flyctl - Deployment software that hosts website
YAML - Formatting of the configuration for deployment

Development

Git clone this repository.
Run npm install in the root directory with this project's package.json.
Run npm run dev to start the project.

Deployment Web

flyctl deploy

fly deploy

webwisdom's People

Contributors

Watchers

webwisdom's Issues

[Paper] 1. Introduction: Problem Definition

[Paper] 6. Requirements analysis: Dynamic model

[Paper] 6. Requirements analysis

[Paper] 1. Introduction: Purpose, scope, and goals of project

[Paper] 3. Project Plan: Project organization

[Paper] 7. System Design: Subsystem decomposition

[Paper] 1. Introduction: Background

[Code] Repository should have some examples of using the different frameworks built in

[Paper] 2. Feasibility Study: High level definition of user requirements

[Paper] 4. Monitoring: Simulation setup

The home page should have a navbar (navigation bar) that can have around 4 different options or more. It should have a multi-select area for different lessons. This should be separated in to different sections that group lessons. Each section should have ~ 3 lessons.

Here is an ugly looking version (it does not include the sections, only a multi-select area for different lessons):

[Code] Create repository with base dependencies

Repository should be created with dependencies: Preact, React, Node, Tailwind, Prefetch, Solidjs, Svelte, Alpinejs, and Lit

[Paper] 1. Introduction: Assumptions and constraints

[Paper] 3. Project Plan: Identification of Tasks, milestones, and deliverables

[Paper] 2. Feasibility Study: Purpose of new system

[Paper] 8. Detailed design: Class diagram

[Paper] 7. System Design: Hardware and software mapping

[Paper] 5. Requirements: Functional requirements

[Paper] 5. Requirements: Non-functional requirements

[Paper] 7. System Design: Security management

[Code] Create home page

[Paper] 1. Introduction: Overview of document

[Paper] 7. System Design

[Code] Project should be viewable via a public URL

[Paper] 7. System Design: Persistent data management

[Paper] 2. Feasibility Study: Recommendations

[Paper] 4. Monitoring: Schedule integrity

[Paper] 3. Project Plan: Risk management plan

[Paper] 2. Feasibility Study: alternative solutions

[Paper] 5. Requirements: Use-case diagram

[Paper] 6. Requirements analysis: Static model

[Design] Editor

The editor should include some navbar that can be completely different than the other pages. It should have some place as a title for that lesson, a sidebar that would have icons to select between the different frameworks, and a triple split-screen as the main content taking up as much space as possible. The triple split-screen should have the left side as some instructions, the middle as a coding area, and the right as a preview. You do not need to include snippets inside the split-screen, just having the division of three sections is good. It should also have a unified footer that will display the framework currently selected, and a couple buttons (the text right now doesn't matter).

Here is an ugly version that does NOT fulfill what it should look like:

[Paper] 8. Detailed design: Database design

[Code] Readme should have a proper description and overview

[Paper] 7. System Design: Overview

[Code] Add Vue to project and example

Astro supports many libraries. React, Preact, Lit, Svelte, are already implemented in the repo. Vue should be added to the project using Astro integrations, and then a corrosponding component made in src/components folder named: vue.ts and consumed (used) in src/pages/index.tsx in the SSR, client-partial hydrated, and client hydrated.