Deploying websites from github

Web Development
1

Hi all,
I’m hoping to develop a website using GitHub but am a bit confused about where the code for the website should actually go. GitHub says the code needs to be in the readMe file, while code academy says it’s ok to make the typical index.html file to start creating content there. Which is the correct or preferred method? Thanks in advance.

2

Hi.
In the readme file you should have a description of your project and instructions on how to reproduce or use it. The code should be created at an early stage as codecademy instructs.

See one of my first projects (portfolio) here:
Repo: GitHub - rui775/myportfolio
Website (Github pages): My Portfolio

Hope this helps. Cheers

3

Thank you. I changed my read me to a .txt file instead of markdown, but my site still references the read me instead of the index.html. Any thoughts on how to redirect?

4

I’ve already experienced your issue.
I’ve deployed from VSCode terminal.
If you are using it with a cloned repository in your local you can follow this instructions.

First run this command:

npm install gh-pages --save-dev

Add this information to your package.json file:

"homepage": "https://<username>.github.io/<repository-name>",
"scripts": {
  "predeploy": "npm run build",
  "deploy": "gh-pages -d build",
}

Next run this commands:

npm run build
npm run deploy

Hope this works.
Let me know the result.

5

Got it!!! Thank you!