Northeastern-Electric-Racing / Northeastern-Electric-Racing/FinishLine
[Admin Tools] - Edit General Description
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 36
- Forks
- 9
- Avg merge
- 4d 21h
- Merged PRs (30d)
- 11
Description
Description
We want there to be a way to edit the general description of an organization. We want an admin to have the ability to update the general description to ensure it is up to date and reflects the current state of the organization. On the admin tools page, under the Guest View Tab we want to add a text box where we can update the general description. When you click the button to update the description, a modal should appear to input the new description.
To be able to update an organization’s general description from the frontend, we need to create a hook that makes an api call to the backend endpoint for returning the organization general description (/organization/general-description/)
Make sure you are signed in as Thomas Emrax (app admin) when working on development mode to access the admin tools page.
Make sure you are signed in as Thomas Emrax (app admin) when working on development mode to access the admin tools page.
Acceptance Criteria
- Text box is added to admin tools page
- Modal appears on edit to update description
- Calls hook to update organization
descriptionfield
Proposed Solution
Use the NERModal.tsx to create a modal with a text field to edit the general description. There are a few examples of text fields being used on a modal on Finishline, one being creating a new car in the admin tools. You can use this as an example. But in this example, when the description is submitted, it should call the hook to update the general description of an organization.
Take a look at some of the other hooks that we have on Finishline, particularly in the organization hooks, which you can use as reference for this hook
Mocks
blocked by #2796
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start on the admin tools page under the Guest View tab, reviewing NERModal.tsx, the organization hooks, and the Finishline car-creation modal example. Check the organization general-description endpoint and the dependency on #2796 before proceeding. Done means an admin can edit the description in a text box and modal, submit it through a hook, and update the organization description.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100