Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update documentation #33

Open
tanmayc07 opened this issue Sep 20, 2020 · 8 comments · Fixed by #36
Open

Update documentation #33

tanmayc07 opened this issue Sep 20, 2020 · 8 comments · Fixed by #36
Assignees
@tanmayc07 @sahilambre @rutu363
Labels
documentation Improvements or additions to documentation
Projects
Mvp
Milestone
MVP Release

Comments

@tanmayc07
Copy link
Owner

  1. Add cover image and badges
  2. Add steps to run this project locally
@tanmayc07 tanmayc07 added the documentation Improvements or additions to documentation label Sep 20, 2020
@tanmayc07 tanmayc07 added this to the MVP Release milestone Sep 20, 2020
@tanmayc07 tanmayc07 self-assigned this Sep 20, 2020
@tanmayc07 tanmayc07 added this to To Do in Mvp via automation Sep 20, 2020
@sahilambre
Copy link
Collaborator

Instead of adding a cover image can we add a gif?

@tanmayc07
Copy link
Owner Author

I think if you can work on making gif of our logo, thats fine then!

@sahilambre
Copy link
Collaborator

Pardon

@sahilambre
Copy link
Collaborator

Update documentation in tanmaydev?

@tanmayc07
Copy link
Owner Author

No the README.md file which will be shown on our github repo

sahilambre added a commit that referenced this issue Sep 22, 2020
@sahilambre
📝 Add cover image and badges #33
ba6df28
sahilambre added a commit that referenced this issue Sep 22, 2020
@sahilambre
📝 Add steps to run locally #33
7ecb89c
@sahilambre sahilambre mentioned this issue Sep 22, 2020
Merged
@tanmayc07 tanmayc07 linked a pull request Sep 22, 2020 that will close this issue
Iss33 #36
Merged
@tanmayc07 tanmayc07 moved this from To Do to In progress in Mvp Sep 22, 2020
tanmayc07 pushed a commit that referenced this issue Oct 19, 2020
@sahilambre
Iss33 (#36)
b92d22c 
* 📝 Add cover image and badges #33

* 📝 Add steps to run locally #33

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md
@sahilambre
Copy link
Collaborator

@tanmayc07 Should I close this issue?

@tanmayc07
Copy link
Owner Author

I think we will need to keep updating documentation, so let's keep this open!

@sahilambre
Copy link
Collaborator

Yeah Sure.

tanmayc07 added a commit that referenced this issue Nov 1, 2020
@tanmayc07 @sahilambre @rutu363
Release 1.0 (#66)
3fdc0bc 
* Test commit for sahildev

* test commit for rutudev

* Initial test commit for tanmaydev

* Test commit

* 💩 add authentication

* 🗃️ Add scripts for /create and /list of blogs

* 🗃️ Add scripts for /update and /delete of blogs

* ➕ Add body-parser dependency

* added landing login reg pages

* 💄 Add create view

* 🚧 Add create and landing view and backend code

* 💫 Add logo

* Merge rutudev

* 🎨 Structure blog routes

* 🚚 Restructure auth routes #4

* 🚚 Restructure auth routes #4

* 🚚 Restructure auth routes #4

* 👽 Add auth middleware for every blog crud operation #6

* 🗃️ Resolve deprecation warning

* ✅ correct auth middleware

* 💄 Change in Register and login page #5

* 🗃️ Generalize database name #10

* 🐛 Login bug resolve

* 💄 Add tui editor in create view #3

* 🔧 password validate

* 💩 Add script for create blog

* 🚧 validations

* ✨ Update create blog script

* 🚧 validations

* 🍻 Done validations #15 #12

* ✨ Render Blog on seperate route

* ✨ Implement back button #18

* 📱 Login view and validations

* 🔥 Remove a temporary file

* 🐛 Fix UI bugs #18 #21

* 🐛 Fix footer in log and reg #21

* commit

* 💄 Connect landing to auth pages

* 💄 Error message styling in auth pages #28

* ✨ Add partial views for blog cards #2

* 🐛 Fix route and changed file name #30

* ✨ Add explore page

* Changes Logout #32

* ⚡ redirects

* 💩 Connect user and blog

* Connect user and blog schemas

* Iss33 (#36)

* 📝 Add cover image and badges #33

* 📝 Add steps to run locally #33

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* ♻️ Remove typo

* 🐛 Fix login and redirect page bug

* ⚡ Secret in .env

* ♻️ Remove comments and extra code #37

* 🗃️ Add author field in blogSchema

* 💄 Add author name on card #42

* ♻️  Redirect to explore after login

* ✨ Explore page patch

* ✨ Add functionality to create button

* ✅ myblogs #45

* 🔨 removes myblog test #45

* ✨ Frontend my blogs #50

* 💄 update ui for frontend myblogs #50

* ✨ Add edit and delete functionality to blogs

* 👽 Integrate mailchimp

* ⚡ adds 404 page

* ✨ Add navbar dropdown and avatar #55

* ➕ Add migrate-mongo dependency

* 📝 Update documentation

* 🐛 Patch

* ♻️ Refactor API to get latest blogs first

* 🔒 Add DB_URI in env

Co-authored-by: sahilambre <sahilws111@gmail.com>
Co-authored-by: Rutu <barve.rutu@gmail.com>
Co-authored-by: Rutu <62687761+rutu363@users.noreply.github.com>
Co-authored-by: Sahil Ambre <59484827+sahilambre@users.noreply.github.com>
tanmayc07 added a commit that referenced this issue Nov 22, 2020
@tanmayc07 @sahilambre @rutu363
🚀 Release 1.1 - Fix UI bugs and add tag feature (#70)
5c2d7ff 
* Test commit for sahildev

* test commit for rutudev

* Initial test commit for tanmaydev

* Test commit

* 💩 add authentication

* 🗃️ Add scripts for /create and /list of blogs

* 🗃️ Add scripts for /update and /delete of blogs

* ➕ Add body-parser dependency

* added landing login reg pages

* 💄 Add create view

* 🚧 Add create and landing view and backend code

* 💫 Add logo

* Merge rutudev

* 🎨 Structure blog routes

* 🚚 Restructure auth routes #4

* 🚚 Restructure auth routes #4

* 🚚 Restructure auth routes #4

* 👽 Add auth middleware for every blog crud operation #6

* 🗃️ Resolve deprecation warning

* ✅ correct auth middleware

* 💄 Change in Register and login page #5

* 🗃️ Generalize database name #10

* 🐛 Login bug resolve

* 💄 Add tui editor in create view #3

* 🔧 password validate

* 💩 Add script for create blog

* 🚧 validations

* ✨ Update create blog script

* 🚧 validations

* 🍻 Done validations #15 #12

* ✨ Render Blog on seperate route

* ✨ Implement back button #18

* 📱 Login view and validations

* 🔥 Remove a temporary file

* 🐛 Fix UI bugs #18 #21

* 🐛 Fix footer in log and reg #21

* commit

* 💄 Connect landing to auth pages

* 💄 Error message styling in auth pages #28

* ✨ Add partial views for blog cards #2

* 🐛 Fix route and changed file name #30

* ✨ Add explore page

* Changes Logout #32

* ⚡ redirects

* 💩 Connect user and blog

* Connect user and blog schemas

* Iss33 (#36)

* 📝 Add cover image and badges #33

* 📝 Add steps to run locally #33

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* ♻️ Remove typo

* 🐛 Fix login and redirect page bug

* ⚡ Secret in .env

* ♻️ Remove comments and extra code #37

* 🗃️ Add author field in blogSchema

* 💄 Add author name on card #42

* ♻️  Redirect to explore after login

* ✨ Explore page patch

* ✨ Add functionality to create button

* ✅ myblogs #45

* 🔨 removes myblog test #45

* ✨ Frontend my blogs #50

* 💄 update ui for frontend myblogs #50

* ✨ Add edit and delete functionality to blogs

* 👽 Integrate mailchimp

* ⚡ adds 404 page

* ✨ Add navbar dropdown and avatar #55

* ➕ Add migrate-mongo dependency

* 📝 Update documentation

* 🐛 Patch

* ♻️ Refactor API to get latest blogs first

* 🔒 Add DB_URI in env

* 💄 Add Date in Cards UI

* ✨ Fix footer in landing

* 💄 Render tags on explore and myblogs

* 💄 Add chips input in update and render blogs categorized by tags

* 💄 Fix UI bugs in update view

Co-authored-by: sahilambre <sahilws111@gmail.com>
Co-authored-by: Rutu <barve.rutu@gmail.com>
Co-authored-by: Rutu <62687761+rutu363@users.noreply.github.com>
Co-authored-by: Sahil Ambre <59484827+sahilambre@users.noreply.github.com>
tanmayc07 added a commit that referenced this issue Feb 9, 2021
@sahilambre @rutu363 @tanmayc07
📝 Add Snapshots in Documentation
f741484 
* Test commit for sahildev

* test commit for rutudev

* Initial test commit for tanmaydev

* Test commit

* 💩 add authentication

* 🗃️ Add scripts for /create and /list of blogs

* 🗃️ Add scripts for /update and /delete of blogs

* ➕ Add body-parser dependency

* added landing login reg pages

* 💄 Add create view

* 🚧 Add create and landing view and backend code

* 💫 Add logo

* Merge rutudev

* 🎨 Structure blog routes

* 🚚 Restructure auth routes #4

* 🚚 Restructure auth routes #4

* 🚚 Restructure auth routes #4

* 👽 Add auth middleware for every blog crud operation #6

* 🗃️ Resolve deprecation warning

* ✅ correct auth middleware

* 💄 Change in Register and login page #5

* 🗃️ Generalize database name #10

* 🐛 Login bug resolve

* 💄 Add tui editor in create view #3

* 🔧 password validate

* 💩 Add script for create blog

* 🚧 validations

* ✨ Update create blog script

* 🚧 validations

* 🍻 Done validations #15 #12

* ✨ Render Blog on seperate route

* ✨ Implement back button #18

* 📱 Login view and validations

* 🔥 Remove a temporary file

* 🐛 Fix UI bugs #18 #21

* 🐛 Fix footer in log and reg #21

* commit

* 💄 Connect landing to auth pages

* 💄 Error message styling in auth pages #28

* ✨ Add partial views for blog cards #2

* 🐛 Fix route and changed file name #30

* ✨ Add explore page

* Changes Logout #32

* ⚡ redirects

* 💩 Connect user and blog

* Connect user and blog schemas

* Iss33 (#36)

* 📝 Add cover image and badges #33

* 📝 Add steps to run locally #33

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* ♻️ Remove typo

* 🐛 Fix login and redirect page bug

* ⚡ Secret in .env

* ♻️ Remove comments and extra code #37

* 🗃️ Add author field in blogSchema

* 💄 Add author name on card #42

* ♻️  Redirect to explore after login

* ✨ Explore page patch

* ✨ Add functionality to create button

* ✅ myblogs #45

* 🔨 removes myblog test #45

* ✨ Frontend my blogs #50

* 💄 update ui for frontend myblogs #50

* ✨ Add edit and delete functionality to blogs

* 👽 Integrate mailchimp

* ⚡ adds 404 page

* ✨ Add navbar dropdown and avatar #55

* ➕ Add migrate-mongo dependency

* 📝 Update documentation

* 🐛 Patch

* ♻️ Refactor API to get latest blogs first

* 🔒 Add DB_URI in env

* 💄 Add Date in Cards UI

* ✨ Fix footer in landing

* 💄 Render tags on explore and myblogs

* 💄 Add chips input in update and render blogs categorized by tags

* 💄 Fix UI bugs in update view

* Add files via upload

Add snapshots of application

* Add files via upload

Add svg snapshots file

* Update README.md

Add snapshots

* Update README.md

update readme with application snapshots

* Update README.md

Update readme with snapshots

Co-authored-by: Rutu <barve.rutu@gmail.com>
Co-authored-by: tanmayc07 <tanmayc32@gmail.com>
Co-authored-by: Tanmay Chaudhari <48885301+tanmayc07@users.noreply.github.com>
Co-authored-by: Rutu <62687761+rutu363@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tanmayc07 tanmayc07

@sahilambre sahilambre

@rutu363 rutu363

Labels
documentation Improvements or additions to documentation
Projects
Mvp
  
In progress
Milestone
MVP Release
Development

Successfully merging a pull request may close this issue.

Iss33 tanmayc07/Blog-App
3 participants
@tanmayc07 @sahilambre @rutu363