Skip to content

KingTechnician/priam

Repository files navigation

Priam

A progressive web application that uses a MongoDB, React, and Netlify serverless function stack.

Purpose

  • Are you a student who has a new idea or concern they would like to make known to the university administration?
  • Are you unsure of the resources or means necessary?

A solution presented by me is Priam, web application that has the goal of making the desires of students more visible to faculty and administration at your university.

How?

  • The Priam system is simple: you might consider it a voting system. Students have the ability to create an account, and propose changes they would like to make to the university in a short post.
  • Categories can be added to the posts to better organize the nature of their requests. Other users have the ability to view these public posts and have the optoon to upvote them.
  • Other users have the ability to iew these public posts and have the option to upvote them.
  • These posts are anonymous. No one will know the author of the post.
  • There are no comments. No judgement necesary.
  • The only metric is upvotes.

There are also basic searching methods to allow you to search posts by name, title or date. You can also sort by category.

User Stories (Subject to change as more features are added)

PriamMobile1.0.0Recording.mp4
PriamRecording1.0.0DesktopUnClipped.mp4

Run Locally

  • Before anything, check out the pre_setup.md to follow how I set up authentication and the server.
  • Want to start small? Not sure if you want to dedicate to a full application?
    • Check out the Lite version of this application (Flask with Python, non-downloadable, basic design)
  • Otherwise, follow the instructions at application_setup.md to set up the application locally.

Steps to a 1.0.0 Production (Complete!)

  • User has the ability to login using university email
  • Only VSU emails are allowed to validate and pass login
  • Profile username is recognized by the application
  • User can query server posts
    • By Title
    • By Description
    • By Tags
  • User can filter server posts
    • By Date
    • By Upvotes
    • By Tags
  • User can create a post with a Title and Description
  • User can add tags to created posts
  • Users are able to upvote desired posts, which are also stored in a server

Committing

  • Helping out with this project is heavily encouraged! I am an undergraduate student still learning React and many other technologies, so your guidance will help me make this project even greater and more useful.
  • I want the documentation to as simple as possible to readable both for experts as well as beginners. If you propose a project change, be sure to also provide some Markdown documentation about the steps you took, or a very detailed explanation of what you did in the description of your commit.

Next Steps

  • Are there ways we can make code more efficient?
  • Can we create a service that creates this application on behalf of others? (Perhaps a website or app that creates personalized Priam systems).

Sponsorship

Managing the servers, authentication, and hosting can be a monthly price, and as I implement this at my university, these costs are likely to increase. If you can, please consider donating. Funds will be used not only to support the technology to manage this app in my campus, but also for future endeavors of making change through software.

KingTechnician

[IMPORTANT]: Update Regarding Development of Priam

  • The next stage of Priam, for the time being, will be in a private repository.

What does this mean?

  • This current code will still be publicly available here. Feel free to use this to create something for yourself.
  • If you would like to contribute to what my next stage of Priam is, feel free to reach out to me.
  • The next stage I am making, when made public for users, will be free with few limitations. I have not changed my stance on making this application as usable as possible for students.
  • To make the progress of my next version more transparent, issues relating to it will be populated here publicly. That way, you can see what my action items are and get a good idea of how far I am.
  • For a more comprehensive look at this, check out the live progress indicator to see where I'm at.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published