Write up documentation on basic project

djbowen95 / Hit-the-Bucket

Front-end BUCKET LIST application built with REACT. Users can add, update or delete items from a bucket list - which persists when they refresh or revisit the page. Uses STATE, HOOKS, COMPONENTS, PROPS, conditional rendering, forms and event handling. Built from starter code.

https://djbowen95.github.io/Hit-the-Bucket/

MIT License

0 stars 0 forks source link

Write up documentation on basic project #9

Open djbowen95 opened 1 year ago

djbowen95 commented 1 year ago

OUTLINE FOR THE README:

Header

[ ] Deployed Link
[ ] About
[ ] Tech Summary
[ ] Bootcamp

About

[ ] Bootcamp Link
[ ] React Week
[ ] Classroom Projects
[ ] Starter Code

Key Features / How to Use:

[ ] Add a Bucket List Item
[ ] Remove a Bucket List Item
[ ] Update a Bucket List Item
[ ] Set an Eagerness Value
[ ] Data Persistance / Refresh the Page

Key Features / Main Tech:

[ ] Components and Props
[ ] State
[ ] LocalStorage
[ ] Event Handling / React Forms
[ ] Conditional Rendering
[ ] UseEffect Hook
[ ] Deployment

Version History:

[ ] Summarise 0.1.0, 0.2.0, 0.3.0

Development + Contribution:

[ ] Outline Plan
[ ] Guidelines / Notes

Notes on Testing:

[ ] General testing link

Contact:

[ ] Details

djbowen95 commented 11 months ago

Badges:

[ ] Deployed Link
[ ] License
[x] Issues
[ ] Contact badges ?
[ ] Release date (?)
[ ] Chat / Twitter (?)
[ ] Version / Release https://shields.io/badges/git-hub-release-with-filter
[x] Size? Rating?
[x] GitHub commit activity Then more long term:
[ ] Dependencies
[ ] Code Cov Percentage

djbowen95 commented 11 months ago

release - release date
deployed - license - size - commits

djbowen95 commented 11 months ago

GitHub release (with filter) GitHub Release Date - Published_At GitHub issues GitHub issues by-label GitHub closed issues GitHub commit activity (branch) GitHub repo size GitHub

djbowen95 commented 11 months ago

Maybe use colours / grey scale to make it less heavy on the eyes if i want to use lost of badges!

deployed link /environment (blue?) - version (orange), release date (orange) #fda325 #008cff
issues grey - blue grey - red grey - grey
license grey, size grey, dependencies grey - connect / contact ( colourful button, auto scrolls to contact section?)