adhocmaster / scrummate Goto Github PK

View Code? Open in Web Editor NEW

This project forked from slugscrum/scrum_tool

1.0 1.0 0.0 68.43 MB

License: MIT License

JavaScript 38.87% TypeScript 59.77% CSS 0.46% HTML 0.90%

scrummate's Introduction

Getting Started with Scrum Tools

This project was initially bootstrapped with Create React App.

This is a fork from Scrum_Tool by a previous team who worked on it as part of UCSC's CSE115d course.

It is now being worked on by a new team of students as part of UCSC's CSE115b/c courses.

Documetation for the API can be found at /documentation/api_documentation.md.

Postgres

To run the backend, you should download and install the Postgres database. We used v16.2, but other versions will likely work too. For development purposes, we expect there to be a database called test and a user with username and password test who has full permissions to access this database.

We have seen issues with the Docker container for Postgres and when running the project from WSL. One workaround to this is to download Postgres directly to your system and running the project your operating system's terminal (e.g. Powershell).

Available Scripts

In the project directory, you can run:

`npm start`

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

Alternatively, you can run npm start in the frontend and backend directories separately.

The page will reload when you make changes.
You may also see any lint errors in the console.

`npm test`

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

Currently, there are only backend tests, located in the backend/tests directory.

`npm run build`

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

See the section about deployment for more information.

`npm run eject`

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

File structure

The project is separated into separate frontend and backend projects, located in the frontend/ and backend/ directories. Each directory is its own node project. They will each start their own servers. The frontend will make API calls to the backend, and the backend will host the API and respond to API calls. The root directory contains some packages used in both the frontend and backend, as well as some documentation and files for GitHub automated tests.

More information

There are READMEs in both the fronend and backend directories which contain more information about their respective projects. Please see them for more information.

Learn More About Create React App

You can learn more in the Create React App documentation, although the project has now been modified extensively from it.

To learn React, check out the React documentation.

scrummate's People

Contributors

Stargazers

Watchers

scrummate's Issues

Changing the displayed page

creating a new revision or making a copy switches to that new one

No way to see acceptance criteria on the card

Maybe we can add a "flip" button? since after it locks then we cant use the edit menu to see it anymore

Can see project details if can make the API calls

If you remove someone from a project but they were still signed in, they are able to continue browsing/changing the project. If they had access to the API somehow, they could load any data from any project as long as they are signed in.

Stories don't update when switching revision

Unless the revision has empty sprints, the list doesnt update

Reorder return when in the same list

if source and destination are the same sprint or both are product backlog, then the return values are both wrong. New source list is missing the item, new destination list has it duplicated.

Deleting sprints doesnt show stories in backlog

frontend and backend have both changed since we implemented this and it hasnt been updated yet

Clean up Formatting with linter/formatter

Currently, the code formatting is inconsistent due to the create-react-app not automatically firing for us.

Navbar does not display current project name

waiting on our own project select page to fix

Fix sprint/backlog height

The product backlog's height must be adjusted. The thin bar does not meet sponsor standards.

Sponsor wants a min-height or a fixed height. There is a Discussion about having it match the screen's height and scrolling with the page if the sprints grow longer than it.

Possibly do this when implementing user stories?