ufosc / club-admin-portal Goto Github PK

There should be a list of events that contains all the data described here. It should be searchable and sort-able. You can add filters such as "past" and "future" that will improve the experience. Keep in mind that this will be connected to the event attendance.

There should be a list of projects that contains all the data described here. It should be searchable and sort-able. Keep in mind that this will be connected to the member list.

This should be an inclusive list of all the use cases we need to meet. Please feel free to suggest more (and I will create an issue for each respective feature). Most functionality will be about data interaction and visualization. The data itself will be stored in a database you can access via a REST API. Any interaction with GitHub or Google Calendar will be handled by the backend.

• Officers will be able to sign in to access information
• Add a new member
• Let project leads update the project description, URL, and active status
• Submit an expense to be processed
• Allow treasurer to approve and reimburse an expense
• Allow officers to create a new event with time, location, event picture, etc
• Allow officers to modify any part of an existing event
• Allow officers to see which members are on which projects, and who isn't on a project
• Let project leads add members to their project
• Let officers get data on sign-ins
  • Visualize a graph of attendance on a meeting to meeting basis
  • Track number of first time sign-ins per meeting
  • See what meetings specific members go to
• Pull generated text about upcoming events for email or Facebook announcements (or actually be able to send out announcements via the List-serve and Facebook)
• Officer should be able to save weekly announcements anyone can access
• Add a member to a the club server with a username. A temporary password, that officers can't see, should be sent to that user so they can login
• Resource text should be kept up-to-date with the club's resources repository (maybe vice-versa)
• Allow officers to remove members (which would affect them signing into GitHub and the server)
• Allow Secretary to add meeting notes to events
• Sign-ins should expire after 15 minutes of unused

Information about what data is available is described in this diagram from the back-end repository.

There should be a list of members that contains all the data described here. It should be searchable and sort-able. Keep in mind that this will be connected to the project list and event attendance.

There should be an ability to modify a projector's data (as described here) (GitHub should handle the creation and removal of projects). It should connect with the list from issue #5.

Need to add all the normal repo files (as described in our project template).

There should be an ability to add a member, modify a member's data (as described here), and remove a member. It should connect with the list from issue #4.

It would be good to put together a style guide for HTML. We have a generic one here, but it doesn't apply quite as well to markup languages.

It shouldn't be too long (people won't read it otherwise). Make a PR on the resources repo and we can review there.

No one, aside from officers, should be able to get access to the portal. There needs to be a login page that will allow users to enter a username and password that would use the backend to authenticate. It should provide feedback on successful or unsuccessful attempts.

I would like to make a decision on using CSS, Sass, SCSS, Less, etc

Could we get a discussion going about people's preference as well as pros and cons (or any weird issues with Vue)?

This will also inform whatever style guide we choose.

There should be an ability to add an event, modify an event's data (as described here), and remove an event. It should connect with the list from issue #6.

We will need to write unit test to make sure the website is working and help prevent regressions. They will need to support mocking REST calls (so we can test without a database). Feel free to do some research.

Could we get a discussion going about preferences, what works best with Vue, etc?

It would be good to put together a style guide for CSS (or whatever alternative is decided in #11). We have a generic one here, but it doesn't apply quite as well to styling languages.

It shouldn't be too long (people won't read it otherwise). Make a PR on the resources repo and we can review there.

Docker would help keep dependencies in-order and make it easy for people to get up and running (including anything needed for testing). The project will also be deployed to the server as a Docker image. After a quick search I found this website, that could help provide some information on using Vue and Docker. Note: The image should also have TypeScript installed as well.