Code Monkey home page Code Monkey logo

yamun's Introduction

yamun's People

Contributors

aidanlanger avatar jackharrhy avatar mudkip avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

yamun's Issues

Iteration 3

From document:

Project document (30 marks)

  1. The team must provide a document that is an update of the former, documenting what was done to
    implement the client-side of the application. What functionalities were implemented? What were
    added that were not planned? What functionalities were removed? Such information should be
    provided in this document.
  2. The document must have a section named Views where you document your views and what you
    can do with them (methods). Why are they necessary for your application?
  3. The document should list and explain the elements used in assembling the client-side.
  4. Describing the animation effects used is also important in this part of the report.

Project code (40 marks)

  1. How much of the functionalities you declared in your project are you covering? Is everything
    working as supposed? Is there anything missing?
  2. Your code should follow the structure detailed in the beginning of this document. Is it following
    the MVC pattern with the models, controllers, routes and view properly?
  3. Is your data being saved properly in the database using the view? How well designed is(are) your
    view(s)?
  4. I will test each functionality using the web interface. Are they working? How are you dealing with
    user inputs? Is it on the client side or server side?
  5. How well-documented are your functions and codes from your view? Are they easily readable?

Video demo (30 marks)

  1. The teams should assemble a video, at maximum 10 minutes.
  2. The video should present in the introduction, the motivation and overall idea and goals of the
    project.
  3. After, the teams should present the architecture with the technologies and libraries used to assemble
    your project.
  4. In the last part, the team should present running examples of the functionalities implemented. What
    do they do? What can be achieved with them?

crn -> sid

CRNs are not unique!
yay!

move to SIDs

composite key of semester letter and year, g if graduate, hyphen, then crn

bookmarks ui

  • add bookmarks
  • remove bookmarks
  • bookmarks screen, manage bookmakrs
  • min / max bookmarks

make configurable things configurable

no more // TODO make configurable; make them configurable

likely define a config.ts file, that brings in things from the environment, and defaults them if it doesn't exist.

after initial data pull, keep data up to date

peridocally, the app should:

  • fetch the people api on a daily basis
  • fetch course information blobs on a twice-a-week basis
  • fetch course information from banner from the current semester on an every-30-minutes basis, since if wish to display waitlists, it be nice to have that information up to date

Iteration 2

  • upload doc here

Code:

  • API spec outlined in the README implmented in full.
  • Tests written for the controllers.
  • Some comments added to models / controllers / other places.

Not required but nice-to-have:

  • UI ideas of what the app can look like from @AidanLanger.
  • Better error handling / messages
  • OpenAPI v3

Documentation:

  • Info on Models.
  • Info on Routes & Controllers.
  • Info on design of collections.
  • Info on tests.
  • Update on what we didn't do that we said we would in the initial document just yet.

From the document

The main goal of the second iteration is to evaluate your server-side code. In the first iteration, your
team has submitted your project's overall idea and goals with some functionalities that your system would like
to provide. Now it's time to code it!
Your team must use an MVC-like framework, as we have seen in the lectures. The project should have
the 'models' with classes and objects that must be manipulated on the server-side. All create, read, update and
delete (CRUD) functions for those objects must be created and documented at this stage. Following the MVC
pattern, your project code must have the 'controller' folder that will manipulate your application's business logic.
All projects must use a database, most of the teams will use MongoDB, but I approved some other options
depending on the project's final goal. Finally, you must assemble an API using express to provide all your
functionalities over HTTP requests. The last part of this deliverable is your server-side tests using Mocha.
Your project will be evaluated into two parts as follows:
Project document (50 marks)

  1. The team must provide a document that is an update of the former, documenting what was done to
    implement the server-side of the application. What functionalities were implemented? What were
    added that were not planned? What functionalities were removed? Such information should be
    provided in this document.
  2. The document must have a section named Models where you document your models and what you
    can do with them (methods). Why are they necessary for your application?
  3. The document must have a section named Routes and Controllers that should report the paths used
    in your API. What each one of them does? How to use them? (Short code-snippets on how to access
    these paths are welcome in your report)
  4. You should show how you designed your Data Model collection(s)? Which pattern is it following
    (embedded or normalized)? Why you chose this particular pattern?
  5. The document must have a section named Tests documenting the tests performed. Which tools were
    used? Which tests were performed? Why? How complete are your tests? Did they cover all success
    and failure cases?
    Project code (50 marks)
  6. How much of the functionalities you declared in the first iteration are you covering? Is it complete
    to start assembling the client-side? Is there anything missing?
  7. Your code should follow the structure detailed in the beginning of this document. Is it following
    the MVC pattern with the models, controllers and routes properly?
  8. Is your data being saved properly in the database? How well designed is(are) your collection(s)?
  9. Are your tests complete, with several success and failing cases? Are you testing your models and
    your full requests properly? Are they covering success and failing cases? Are you doing simple
    and complex use cases for testing?
  10. How well-documented are your functions and codes? Are they easily readable?

add sensible limits to things around the app so things don't overflow

  • username min max
  • username min max test
  • password min max
  • password min max test
  • max course bookmarks
  • max course bookmarks test
  • max schedules
  • max schedules test
  • max courses in schedule
  • max courses in schedule test
  • max title / desc length in schedule
  • max title / desc length in schedule test
  • validate that UI handles super long values correctly

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.