Skip to content

Commit

Permalink
Essential documentation
Browse files Browse the repository at this point in the history 
- Links to sample and screenshots.
- Architectural explanation.
  • Loading branch information
@technoveltyco
technoveltyco committed Mar 2, 2023
1 parent 22834f6 commit a72963b
Show file tree
Hide file tree
Showing 8 changed files with 283 additions and 71 deletions.
179 changes: 109 additions & 70 deletions README.md
View file

Large diffs are not rendered by default.

Binary file added docs/assets/img/Screenshot 2023-03-02 112554.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/img/Screenshot 2023-03-02 113146.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/img/Screenshot 2023-03-02 at 11-24-22 My Team.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/sample/My Team.pdf
View file
Binary file not shown.
Binary file added docs/assets/sample/team-1677691404111.zip
View file
Binary file not shown.
173 changes: 173 additions & 0 deletions docs/assets/sample/team.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@

<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta http-equiv="X-UA-Compatible" content="ie=edge" />
<title>My Team</title>
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css"
integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
<link rel="stylesheet" href="style.css">
<script src="https://kit.fontawesome.com/c502137733.js"></script>
</head>

<body>
<div class="container-fluid">
<div class="row">
<div class="col-12 jumbotron mb-3 team-heading">
<h1 class="text-center">My Team</h1>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="team-area col-12 d-flex justify-content-center">

<div class="card employee-card">
<div class="card-header">
<h2 class="card-title">Professor X</h2>
<h3 class="card-title"><i class="fas fa-mug-hot mr-2"></i>Manager</h3>
</div>
<div class="card-body">
<ul class="list-group">
<li class="list-group-item">ID: 001</li>
<li class="list-group-item">Email: <a href="mailto:[email protected]">[email protected]</a></li>
<li class="list-group-item">Office number: 100</li>
</ul>
</div>
</div>

<div class="card employee-card">
<div class="card-header">
<h2 class="card-title">Cyclops</h2>
<h3 class="card-title"><i class="fas fa-glasses mr-2"></i>Engineer</h3>
</div>
<div class="card-body">
<ul class="list-group">
<li class="list-group-item">ID: 002</li>
<li class="list-group-item">Email: <a href="mailto:[email protected]">[email protected]</a></li>
<li class="list-group-item">GitHub: <a href="https://github.com/https://github.com/cyclops" target="_blank" rel="noopener noreferrer">https://github.com/cyclops</a></li>
</ul>
</div>
</div>

<div class="card employee-card">
<div class="card-header">
<h2 class="card-title">Beast</h2>
<h3 class="card-title"><i class="fas fa-glasses mr-2"></i>Engineer</h3>
</div>
<div class="card-body">
<ul class="list-group">
<li class="list-group-item">ID: 003</li>
<li class="list-group-item">Email: <a href="mailto:[email protected]">[email protected]</a></li>
<li class="list-group-item">GitHub: <a href="https://github.com/https://github.com/beast" target="_blank" rel="noopener noreferrer">https://github.com/beast</a></li>
</ul>
</div>
</div>

<div class="card employee-card">
<div class="card-header">
<h2 class="card-title">Marvel Girl</h2>
<h3 class="card-title"><i class="fas fa-glasses mr-2"></i>Engineer</h3>
</div>
<div class="card-body">
<ul class="list-group">
<li class="list-group-item">ID: 004</li>
<li class="list-group-item">Email: <a href="mailto:[email protected]">[email protected]</a></li>
<li class="list-group-item">GitHub: <a href="https://github.com/https://github.com/MarvelGirlPhoenix" target="_blank" rel="noopener noreferrer">https://github.com/MarvelGirlPhoenix</a></li>
</ul>
</div>
</div>

<div class="card employee-card">
<div class="card-header">
<h2 class="card-title">Wolverine</h2>
<h3 class="card-title"><i class="fas fa-glasses mr-2"></i>Engineer</h3>
</div>
<div class="card-body">
<ul class="list-group">
<li class="list-group-item">ID: 005</li>
<li class="list-group-item">Email: <a href="mailto:[email protected]">[email protected]</a></li>
<li class="list-group-item">GitHub: <a href="https://github.com/https://github.com/wolverine" target="_blank" rel="noopener noreferrer">https://github.com/wolverine</a></li>
</ul>
</div>
</div>

<div class="card employee-card">
<div class="card-header">
<h2 class="card-title">Storm</h2>
<h3 class="card-title"><i class="fas fa-glasses mr-2"></i>Engineer</h3>
</div>
<div class="card-body">
<ul class="list-group">
<li class="list-group-item">ID: 006</li>
<li class="list-group-item">Email: <a href="mailto:[email protected]">[email protected]</a></li>
<li class="list-group-item">GitHub: <a href="https://github.com/https://github.com/storm" target="_blank" rel="noopener noreferrer">https://github.com/storm</a></li>
</ul>
</div>
</div>

<div class="card employee-card">
<div class="card-header">
<h2 class="card-title">Rogue</h2>
<h3 class="card-title"><i class="fas fa-user-graduate mr-2"></i>Intern</h3>
</div>
<div class="card-body">
<ul class="list-group">
<li class="list-group-item">ID: 007</li>
<li class="list-group-item">Email: <a href="mailto:[email protected]">[email protected]</a></li>
<li class="list-group-item">School: Xavier Institute</li>
</ul>
</div>
</div>

<div class="card employee-card">
<div class="card-header">
<h2 class="card-title">Gambit</h2>
<h3 class="card-title"><i class="fas fa-user-graduate mr-2"></i>Intern</h3>
</div>
<div class="card-body">
<ul class="list-group">
<li class="list-group-item">ID: 008</li>
<li class="list-group-item">Email: <a href="mailto:[email protected]">[email protected]</a></li>
<li class="list-group-item">School: Xavier Institute</li>
</ul>
</div>
</div>

<div class="card employee-card">
<div class="card-header">
<h2 class="card-title">Jubilee</h2>
<h3 class="card-title"><i class="fas fa-user-graduate mr-2"></i>Intern</h3>
</div>
<div class="card-body">
<ul class="list-group">
<li class="list-group-item">ID: 009</li>
<li class="list-group-item">Email: <a href="mailto:[email protected]">[email protected]</a></li>
<li class="list-group-item">School: Xavier Institute</li>
</ul>
</div>
</div>

<div class="card employee-card">
<div class="card-header">
<h2 class="card-title">Bishop</h2>
<h3 class="card-title"><i class="fas fa-user-graduate mr-2"></i>Intern</h3>
</div>
<div class="card-body">
<ul class="list-group">
<li class="list-group-item">ID: 010</li>
<li class="list-group-item">Email: <a href="mailto:[email protected]">[email protected]</a></li>
<li class="list-group-item">School: Xavier Institute</li>
</ul>
</div>
</div>

</div>
</div>
</div>
</body>
</html>

2 changes: 1 addition & 1 deletion index.mjs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ function addEmployeeIntoTeam(team, type, ...data) {
// const employee = new Employee(...data);
// - With factory method:
// const employee = Employee.createEmployee(...data);
// - With abstract method: (the one used here)
// - With abstract factory method: (the one used here)
// const employee = EmployeeFactory.createEmployee("manager", ...data);
const employee = EmployeeFactory.createEmployee(type, ...data);
if (employee instanceof Employee) {
Expand Down

0 comments on commit a72963b

Please sign in to comment.