Work to be done for website

[KendallDoesCoding]

Following our discussion in #1 , creating a discussion for us to talk about what has to be done for the website.

cc: @Adarsh-jaiss @vikasganiga05

[vikasganiga05]

Hi folks, please share your thoughts on the website.

[KendallDoesCoding]

Hi Vikas,

Will share in a bit.

Thanks

[Adarsh-jaiss]

Kindly send the link :)

[Adarsh-jaiss]

https://unruffled-chandrasekhar-ffade4.netlify.app

This is displaying coming soon

[KendallDoesCoding]

Kindly send the link :)

@Adarsh-jaiss, we haven't started work. I meant that will share thoughts in a bit.

[KendallDoesCoding]

Okay, so here are my thoughts and what needs to be done:

• We need to make a website link Linkfree but here instead of the profile opening in browser if the button is pressed the file just downloads on the computer (I can try to do this, so this is assigned to me (@KendallDoesCoding)
• We had the option to always update the HTML when someone adds their journey, or to automatically update it using something similar to what Linkfree does, @Adarsh-jaiss decided to make it update automatically, to not give us extra work (assigned to @vikasganiga05)
  • @vikasganiga05 I would like to know in which language you can program the above, JS I hope can do this so I can work on the website accordingly.
• I have also asked @shourgamer2 who seems to be a good web-dev if he can help either me or @vikasganiga05 .
• I think a while ago @TechStudent11 said he could also help with the website, but he seems to be pretty busy these days so I don't want to bother him, in that case.

I am free most of the time, please let me know when we can get to work on this @vikasganiga05

@Adarsh-jaiss - Please invite @vikasganiga05 to be the repo collab
@vikasganiga05 - We will have to work on the website in the branch: website, the branch will deploy onto https://unruffled-chandrasekhar-ffade4.netlify.app/ for the time-being, when the website is made we will go into either buying the domain or getting a better domain for free, for that matter.

cc: @Adarsh-jaiss - Please confirm that only the above mentioned as to be done for the website.

Thanks,
Kendall Does Coding

[TechStudent10]

*Correction; I'm not always on GitHub, at least not as much as before.

[KendallDoesCoding]

Yeah, sorry I framed it badly

[Adarsh-jaiss]

@KendallDoesCoding yes everything is okay, if you could also add online reading about people journeys ( which means pepole can either read it online or can download people journeys)

[KendallDoesCoding]

@KendallDoesCoding yes everything is okay, if you could also add online reading about people journeys ( which means pepole can either read it online or can download people journeys)

Ok, then instead of a text file, the .md file can be made into a PDF which can be read online as well, is that possible @vikasganiga05 ?

[vikasganiga05]

Hi, I found an excellent tool called Docsify. Using this we can convert MD to HTML. Also, it provides plugins to convert to PDF too. I don't know how to implement it, I need some time to go through docs or tutorial videos. Please take a look at it. 🙂

[KendallDoesCoding]

Hi Vikas, yeah ik about Docsify, but I haven't gotten too deep into it, using the tool will make it much easier for us to do the website. Although just have some queries which I will leave below

• will docsify work with a Netlify site or will it only work with GitHub Pages?
• if the user opens the PDF in the browser, will they see a button to download the pdf to their computer/mobile, device.
• will we be able to add 2 buttons before the user opens the page, for either downloading on device or opening in browser.

[vikasganiga05]

Yes, it will work with Netlify too. Where do we store pdf files? If we store them on the project, then I found a gh-action. Which converts markdown to pdf, when we push changes to the specified branch(in our case main/website).

GitHub Action → Markdown to PDF and HTML

Docsify allows adding the download attribute to links. But we need to test this one.

[KendallDoesCoding]

Yes, it will work with Netlify too

Oh cool.

Where do we store pdf files?

We are just planning to store .md files in this repo but @Adarsh-jaiss wants a view of the .md file in the browser, hence I thought of the pdf idea, cause that will help a lot.

If we store them on the project

As I stated above, we are only planning to store .md files in this repo, is it required for us to store pdf files too?

Docsify allows adding the download attribute to links. But we need to test this one.

Ok, cool.

[vikasganiga05]

Yes, we need to convert .md to .pdf and store it in the repo. Because downloading the user journey in the website.

[vikasganiga05]

We are using Netlify. It can run some scripts(I mean build command) on code push to the repo. So, we can do like this 👇

• Need to have two directories. one for journeys and one for pdfs(or ./asset/pdfs).
• When the user adds and pushes his/her journey to the repo, Netlify will convert .md to pdf and store it in the pdfs directory.
• Need to find a good npm package that converts .md to .pdf. I have found one → markdown-pdf, but its last published was 3 years ago. If you know of any other packages please let me know.

For this to work properly, The journeys .md filenames should be unique. For Example <your-github-username>.md

[KendallDoesCoding]

Need to have two directories. one for journeys and one for pdfs(or ./asset/pdfs).

Ok cool.

When the user adds and pushes his/her journey to the repo, Netlify will convert .md to pdf and store it in the pdfs directory.

Will Netlify be able to do it or will we need a GitHub action?

Need to find a good npm package that converts .md to .pdf. I have found one → markdown-pdf, but its last published was 3 years ago. If you know of any other packages please let me know.

Is this really required, if it is then I won't be able to work on this part because node, react, doesn't work on my laptop, computer.

For this to work properly, The journeys .md filenames should be unique. For Example .md

Yup ofc, we can inculde this in the instructions.

[vikasganiga05]

Sorry, I was busy with a hackathon. So, not started testing. Give me some time to work on this. Thank You 🙏

[KendallDoesCoding]

Sorry, I was busy with a hackathon. So, not started testing. Give me some time to work on this. Thank You 🙏

Sure, take your time

[KendallDoesCoding]

@vikasganiga05 @Adarsh-jaiss - Instead of making it so that, the files get downloaded on computer as .txt, let's just do a browser view of the file, as it will make our lives much easier, if people want to download the .md files, they can do it from this repo and I believe it's responsive in notepad, etc...

If we do this, our life will become super easy as GitHub Pages can host .md files as a static website per page I believe, but I'm unsure, I need to test it further.

A few days ago, I made a .md file in my repo called Best-Hosting-Service and using that .md file it generated a website with a theme of my choice: https://kendalldoescoding.github.io/Best-Hosting-Service... Although, as mentioned above, I am unsure if it only works for index.md file for GitHub pages or for all the .md files in the repo, so will test and let yall know if this works for yall.

Waiting for your reply.

[KendallDoesCoding]

Ok cool, will this work with GitHub pages tho @vikasganiga05

[KendallDoesCoding]

@vikasganiga05 Please clarify the following:

• Will this be able to be run locally
• @Adarsh-jaiss Is setting up the GitHub Pages site in the main branch so please get to work over there, if possible
  Also, please let me know by when will this be ready to go/be done?

[KendallDoesCoding]

@vikasganiga05 Please let me know the above, also please let me know what the action is called.

[vikasganiga05]

Ok cool, will this work with GitHub pages tho @vikasganiga05

No

[KendallDoesCoding]

Then how will it work @vikasganiga05 ?

[TechStudent10]

@KendallDoesCoding there is a problem with your idea; how do you upload to the repo? And what if someone puts something really bad? Then what? The repo get's deleted by GitHub? You really want to risk @Adarsh-jaiss account? You should upload the journey to a database and display it from there. You can use Firebase as a simple way to setup a database.

[KendallDoesCoding]

@TechStudent11 Thought that anyone even without using GitHub using the website can magically access the repo and commit BAD journey's using .md files, but that's not how it works. Users need to make their PR on github.

[KendallDoesCoding]

I would say, do whatever the project requires, but play safe guies 😄😄

Yeah exactly.. @TechStudent11 misunderstood my idea, which is no worries but yeah

[Adarsh-jaiss]

Yes but, I personally and believe all open-source people should READ the files before merging into the repo? And also there are horrible websites hosted on GitHub pages, nothing will happen to your account, don't worry.

We just have to pay attention before merging, that's all.

👍👍

[TechStudent10]

@TechStudent11 Thought that anyone even without using GitHub using the website can magically access the repo and commit BAD journey's using .md files, but that's not how it works. Users need to make their PR on github.

... Bruh

[TechStudent10]

@KendallDoesCoding I know that. You just confused us on what your idea is.

[KendallDoesCoding]

@Adarsh-jaiss ig you can delete the Netlify site as we will be using GitHub Pages now, you know how to set that up. Please setup a theme as well :)

[KendallDoesCoding]

the other website = the website to list all the previews to each journey

[KendallDoesCoding]

Let me know when the setup is done

[Adarsh-jaiss]

Okah

[KendallDoesCoding]

@Adarsh-jaiss Thanks, my journey is now hosted: https://adarsh-jaiss.github.io/journey-book/journeys/KendallDoesCoding

[Adarsh-jaiss]

Yeah 😄👍

[vikasganiga05]

Hi, @Adarsh-jaiss & @KendallDoesCoding , I created a test repo for testing the docsify features. Check it out 👇
Your thoughts on this approach?

GitHub Repo → neontuts/docsify-test
Live Preview → https://neontuts-docsify-test.netlify.app/

[KendallDoesCoding]

Hey Vikas,
Only one issue. The text in the README doesn't look nice, is there another way of doing this by creating another file?
{{ user.name }}

<script> new Vue({ el: '#usersList', data: function() { return { users: null, }; }, created: function() { fetch("Data.json") .then(res => res.json()) .then(data => (this.users = data)) .catch(err => console.log(err)); } }); </script>

Yes, we can create Index.md file and add these scripts there. It's easy to configure. Here is the docs → https://docsify.js.org/#/configuration?id=homepage

Can you please do that :)

[vikasganiga05]

Okay, in the test repo right?

[KendallDoesCoding]

Yes

[vikasganiga05]

Hi @KendallDoesCoding , I changed the homepage of the website. Now the README.md file looks good. And sorry for the delay 🙂

Check it out 👇

GitHub Repo → neontuts/docsify-test
Live Preview → https://neontuts-docsify-test.netlify.app/

[vikasganiga05]

It's looking great smiley... Can we add a search feature too?

I added the search plugin but it searches only the homepage not include the journeys dir.

[vikasganiga05]

I am very bad at design anyone can create a simple card for the home page to show all the user's cards. Try to use one color while designing the cards.
Here is the wireframe for that 👇

[Adarsh-jaiss]

Or light green

[KendallDoesCoding]

I am very bad at design anyone can create a simple card for the home page to show all the user's cards. Try to use one color while designing the cards. Here is the wireframe for that 👇

Hi Vikas,

Can you please make a issue on this instead of including it in this discussion, thanks.

[vikasganiga05]

Okay i will create a issue for that :)

[KendallDoesCoding]

Thanks!

[vikasganiga05]

Thanks!

You're welcome

[KendallDoesCoding]

@cojored as stated by you, you want to help with this, can you please let me know, what languages you know to code :)

thanks,
kendall

cc: @vikasganiga05 @Adarsh-jaiss

[KendallDoesCoding]

Thanks a ton, Vikas. Please give me and Adarsh collab access to the repo.

…

On Thu, 30 Jun 2022 at 09:00, Vikas Ganiga ***@***.***> wrote: Hi @KendallDoesCoding <https://github.com/KendallDoesCoding> , I changed the homepage of the website. Now the README.md file looks good 🙂 Check it out 👇 GitHub Repo → neontuts/docsify-test <https://github.com/neontuts/docsify-test> Live Preview → https://neontuts-docsify-test.netlify.app/ — Reply to this email directly, view it on GitHub <https://github.com/Adarsh-jaiss/journey-book/discussions/32#discussioncomment-3053084>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AUGJUTM7QMWPVYPUGRY2SFDVRUIG7ANCNFSM5VVWX4HA> . You are receiving this because you were mentioned.Message ID: ***@***.*** com>

[vikasganiga05]

Hi @KendallDoesCoding & @Adarsh-jaiss , I added both of you to the repo please check it out.

[KendallDoesCoding]

Thanks!

[KendallDoesCoding]

It's not visible to me.

…

On Thu, 30 Jun 2022 at 09:08, Vikas Ganiga ***@***.***> wrote: It's looking great smiley... Can we add a search feature too? I added the search plugin but it searches only the homepage not include the journeys dir. — Reply to this email directly, view it on GitHub <https://github.com/Adarsh-jaiss/journey-book/discussions/32#discussioncomment-3053110>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AUGJUTNNN5SGA7BWRG3KFTDVRUJCPANCNFSM5VVWX4HA> . You are receiving this because you were mentioned.Message ID: ***@***.*** com>

[vikasganiga05]

The search input is on the top left corner of the website.

[Adarsh-jaiss]

guys , is there any progress on this project? @KendallDoesCoding @vikasganiga05

[KendallDoesCoding]

@vikasganiga05 Need some inputs from your end

* Will the docsify update automatically when a profile is made?

* The docsify interface looks much better then the site I generated.

Yes, It will update automatically.

Hi,

I did a test in commit 7248704 and it didn't work automatically.

I think I messed something up on this by accident, sorry.

[vikasganiga05]

The user needs to add the file and make a new entry on the Data.json file to list on the home page.

[KendallDoesCoding]

Ooh, I thought a gh-action would do that for them but no worries!! We should list that in the sharing your experience page.

[vikasganiga05]

Ooh, I thought a gh-action would do that for them but no worries!! We should list that in the sharing your experience page.

Okay, We can implement that in the future.

[Adarsh-jaiss]

Hi Adarsh, Shouldn't it be a organization if it's a community and not a person github account?

YESS, it's possible to transfer repo very easily, if your the owner of the account more easy, if someone else owns the account, you will have to request them to accept the migration request.

I am the owner of that GitHub account. So it would be great if we move it to that account :)
Tell me one thing, what will work perfectly

1. Transfer the repository after completing the project
2. Transfer the repository now and we will do left work after that
   Please let me know :) @KendallDoesCoding

[Adarsh-jaiss]

[KendallDoesCoding]

Yup, I knew about this.

[KendallDoesCoding]

@vikasganiga05 @Adarsh-jaiss I've worked on the website quite a bit, and added different pages, example What is this project, Why we created this project, etc using text from this repos README.md, Although, I wanted to know from you @vikasganiga05 , if there is a way to set it that if text updated in README.md it gets updated within the page as well, because otherwise we will have to update text in the README.md as well as in the page, and that causes double work, even though it's not really a big issue.

So let me know.. Thanks

PREVIEW: https://deploy-preview-2--neontuts-docsify-test.netlify.app/

[vikasganiga05]

Yes, it is possible but we need to find a gh-action to do that.

[KendallDoesCoding]

Ok cool, I'm bad at finding gh-actions but will have a look around.

[vikasganiga05]

No worries we will find one.

[KendallDoesCoding]

No worries we will find one.

👍

[KendallDoesCoding]

This is the best I could find: https://github.com/marketplace/actions/json2table

[KendallDoesCoding]

Yes, but in my eyes, a community should be a organization, You, Vikas, Me can always be the owners of the organization, but it's up to you :) The website is pretty much done, so you can transfer the repo now itself, but it's up to you.

…

On Thu, 14 Jul 2022 at 01:09, Adarsh jaiswal ***@***.***> wrote: Hi Adarsh, Shouldn't it be a organization if it's a community and not a person github account? YESS, it's possible to transfer repo very easily, if your the owner of the account more easy, if someone else owns the account, you will have to request them to accept the migration request. I am the owner of that GitHub account. So it would be great if we move it to that account :) Tell me one thing, what will work perfectly 1. Transfer the repository after completing the project 2. Transfer the repository now and we will do left work after that Please let me know :) @KendallDoesCoding <https://github.com/KendallDoesCoding> — Reply to this email directly, view it on GitHub <https://github.com/Adarsh-jaiss/journey-book/discussions/32#discussioncomment-3140560>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AUGJUTKXINMR5RPXZ75RWC3VT4LQFANCNFSM5VVWX4HA> . You are receiving this because you were mentioned.Message ID: ***@***.*** com>

[Adarsh-jaiss]

We are the owners bro!
That is our community. I am the founder of that community bro

[KendallDoesCoding]

Yes, but all the community's I've seen are GitHub organization, can you make it a GitHub organization? But it's up to you :)

Ex: EddieHubCommunity

[vikasganiga05]

Yes, but all the community's I've seen are GitHub organization, can you make it a GitHub organization? But it's up to you :)

Ex: EddieHubCommunity

Your right, but they already made it has a GitHub account and started working on it.

[collab-community]

-- @KendallDoesCoding @vikasganiga05 guys, I have transferred the repository.
-- kindly check out,is everything is working perfectly or not :)

[KendallDoesCoding]

@collab-community Everything seems to be working fine, Although, Request you to please fork this repo onto your @Adarsh-jaiss account.

[KendallDoesCoding]

@collab-community Everything seems to be working fine, Although, Request you to please fork this repo onto your @Adarsh-jaiss account.

Oops sorry, please fork it with another repo name tho, coz otherwise redirects wont work.

[KendallDoesCoding]

Fork it with like journey-book-fork or something

[Adarsh-jaiss]

yes i have forked it :)

[KendallDoesCoding]

Thanks a ton!

[KendallDoesCoding]

Yeah, so it's fine now!

…

On Thu, 14 Jul 2022 at 19:59, Vikas Ganiga ***@***.***> wrote: Yes, but all the community's I've seen are GitHub organization, can you make it a GitHub organization? But it's up to you :) Ex: EddieHubCommunity Your right, but they already made it has a GitHub account and started working on it. — Reply to this email directly, view it on GitHub <https://github.com/Adarsh-jaiss/journey-book/discussions/32#discussioncomment-3147674>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AUGJUTJZCQSZCXLZAWBRF6DVUAP6DANCNFSM5VVWX4HA> . You are receiving this because you were mentioned.Message ID: ***@***.*** com>

[collab-community]

great :)

[KendallDoesCoding]

@vikasganiga05 Please confirm if the website is good to go and will make @collab-community (@Adarsh-jaiss ) review it.

What we require to do, after merging the website to this repo or before is:

• gh-action to update text (sections) from README.md to the individual page of the website (not so important)
• gh-action to hyperlink the name of the user from .json file and link their journey via a hyperlink in the sidebar
• Maybe add a navbar.

[KendallDoesCoding]

https://deploy-preview-2--neontuts-docsify-test.netlify.app/

[vikasganiga05]

For the user hyperlinks on the sidebar, we don't need gh-action. It can be done using the Vue.js as done in 👇

[vikasganiga05]

Sorry, I forgot about it 😅

[vikasganiga05]

By the way, the website looks good to me.

[KendallDoesCoding]

For the user hyperlinks on the sidebar, we don't need gh-action. It can be done using the Vue.js as done in 👇

Hi, Please work on this, if possible can it get done by tommrow?