Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update github.io page with developer documentation #1

Open
cammoore opened this issue Jan 14, 2023 · 0 comments
Open

Update github.io page with developer documentation #1

cammoore opened this issue Jan 14, 2023 · 0 comments
Assignees

Comments

@cammoore
Copy link
Contributor

cammoore commented Jan 14, 2023

Please do work for this task in a branch named issue-001.

Edit the index.md file in bowfolios.github.io to document this system:

  • Explain the join collections and the data model.
  • Provide a walkthrough of the pages in the site.
  • Explain the use of meteor methods. (Provide link in Methods.js file)
  • Make the application a template so that students can easily hack it.
  • Use of indexes to guarantee uniqueness of fields used as keys.

Possible extensions:

  • DIsplay home page for project as an icon.
  • Add ability to edit and delete Projects.
  • Add an "owner" field to restrict editing access to projects you've created.
  • Add ability to add, edit, and delete Interests.
  • Show better error message when trying to define a duplicate Project.
  • Provide admin-only capabilities (delete user?)
  • Implement testing
  • Implement documentation.js
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

No branches or pull requests

2 participants