dcsil / konsensus-app-backend Goto Github PK

Backend should be able to save files uploaded by the frontend.

MySql should have tables with the appropriate columns for users, files and permissions.

You have a script/bootstrap script, bin/bootstrap script, or similar, available and able to be run on Unix systems (Sorry Windows Users).

This should install dependencies if needed like Postgres, MySQL, Redis, etc

This should install any languages required

This should install any packages like Rubygems, Node Packages, etc

Docker Compose or Docker is ok to use

Also add fake credentials to .env.example

Create GET /organization

Should return the organization model of the current user as well as a list of users in that organization
Should look like

{
...organizationModel,
users: [...]
}

User should be able to register with unique credentials

You must set up Sentry (exception tracking) for all supported platforms and logging to an external system (e.g. not just to STDOUT) for web servers

• sentry setup
• external logging (sumologic? cloudwatch?)

Currently can't obtain the filesize on the frontend for files, and this is needed for the second column below:

Need referrals to an organization. Use auth0?

This repo has workflows that have no defined timeouts and/or are not using self-hosted.

We use self hosted runners to avoid overage costs associated with GitHub Actions. However, we don't have a lot of workers to handle all of the load.
To ensure a single build doesn't spend hours and monopolize our workers, we limit each job to 20 minutes.
Please add a timeout to your jobs. We will disable your actions until you add them.

Your build may also be missing self-hosted in the runs-on field.

Docs: https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idtimeout-minutes
Example:

jobs:
  build:
    runs-on: self-hosted # This is required
    timeout-minutes: 20 # Add this line here

Affected Workflows:

This repo has workflows that have no defined timeouts and/or are not using self-hosted.

We use self hosted runners to avoid overage costs associated with GitHub Actions. However, we don't have a lot of workers to handle all of the load.
To ensure a single build doesn't spend hours and monopolize our workers, we limit each job to 20 minutes.
Please add a timeout to your jobs. We will disable your actions until you add them.

Your build may also be missing self-hosted in the runs-on field.

Docs: https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idtimeout-minutes
Example:

jobs:
  build:
    runs-on: self-hosted # This is required
    timeout-minutes: 20 # Add this line here

Affected Workflows:

There are already user routes in the API, but we need to add some extra fields and methods.

Create slides and/or prepare something to show to the class.

Congratulations on finishing the course!

To make sure we have enough GitHub Actions minutes for the next term, we have automatically disabled your repository's actions.

Feel free to make this repo public or fork to your own org, but we do ask that you leave a copy in the DCSIL org :)

Code Climate Quality Checks are required for the final software we submit.

Software Requirements: All of your repos have been added to Code Climate. Your repo should maintain a minimum "B" average in "maintainability".

This isn't the best metric to ensure code quality, and in practice, you would use this to help inform a decision, not make a decision. In this case, checking a grade is a simple way for the teaching staff to gauge code quality without spending hours reviewing each repository.

set up a developer environment, including a bootstrap script

Show your application running on CI, which means some basic tests (at minimum). Show us your test harness, what library did you choose, what troubles did you have?

CRUD routes for permissions.

You must set up a test infrastructure and a CI System. Julian recommends using GitHub Actions.

Plan out and document the APIs we are exposing to the frontend of the application.
Need feedback from frontend devs -- what information do we need shown on the different pages and what actions do we need to allow?

CRUD routes for organizations + Add models to DB.