Skip to content

AlgoLearnWCSU/AlgoLearn

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AlgoLearn

A web based platform for learning algorithms

Table of contents

User Manual

Login

To login, user will click login with GitHub in top right corner of site. User will be redirected and prompted to sign in with their GitHub account. If user does not have GitHub account they cannot alter anything on the site i.e create a problem, solve a problem, leave comments, etc.

Logout

To log out of the website the user will have to click on the top right icon next to their GitHub icon. Once log out is clicked the user will be logged out and redirected back to the homepage.

Learn Page

Learn page is a collection of algorithms, each algorithm can be opened and users are prompted with a visual of the algorithm, an explanation or pseudocode and the JavaScript implementation.

Practice Page

Learn page is a collection of problems users are working on and practicing their algorithm knowledge. Users can browse through problems and click on any problem to open it and work on. Users can click on filter which will give them the ability to filter by catagory. If user clicks on Create New Problem, the user will be redirected to a problem creation page. On this page they must enter a Problem Name and description, users can add catagories, and must enter at least 3 test cases that the code will test once ran. Once desired fields are filled out by a user, they can submit their new problem to be reviewed by an admin who will determine if the problem is acceptable.

Discussion Page

In the practice page, users can access a discussion page by clicking the first icon on the far right of the problem links. Once user clicks on the icon for discussions they are redirected to the page and will see all of the available information on the problem. At the bottom of the page after the problem information users will see discussions that are on going, users will also see a text box that they can enter their own comments to become a part of the discussion. One a comment is added, the user who has posted that comment will have the ability to delete or edit it. At the top of the discussions area, users can click on "Solve the Problem" which will redirect them back to the solve page.

Leaderboard Page

In the practice page, users can access a leaderboard page by clicking the second icon on the far right of the problem links. Once user clicks on the icon for leaderboard they are redirected to the page and will see all users who have solved the problem that they clicked on. Leaderboard page will show how many tests the user has passed, the codes computation time and the code that they have submitted. At the top of the leaderboard area, users can click on "Solve the Problem" which will redirect them back to the solve page.

Contact Page

Contact page is for users to send comments or any problems they have found. User will type their comment or problem into the box and press send for the message to be sent to developers to read.

Technologies Used

  • TypeScript
  • Kotlin
  • Microsoft Server SQL
  • Angular
  • Azure
  • PostgreSQL
  • VScode
  • Node.js
  • NPM
  • IntelliJ

Contributors:

Adam Jeniski
https://github.com/Ajetski
https://www.linkedin.com/in/adamjeniski/

Caleb Garrick
https://github.com/calebGarrick
https://www.linkedin.com/in/caleb-garrick-01389513b/

John Bouchard
https://github.com/Booshmagoosh
https://www.linkedin.com/in/john-bouchard-3214151bb/

Ty Doris
https://github.com/tyjdor
https://www.linkedin.com/in/ty-doris-1202a0151/

John Williams
https://github.com/Minedbender
https://www.linkedin.com/in/john-williams-a679bb18a/

License

Copyright (c) 2020 Algolearn

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (Algolearn), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Acknowledgments

About

A web based learning platform for algorithms

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published