โฆ First-time setup ยท For complete beginners
Zero to localhost:run recode hive on your computer
Never used GitHub? Perfect. In about 30 minutes you will fork the project, download it, and see the recode hive website running on your own machine. Tick each step as you go. We save your progress.
- 20 to 30 minutes
- 10 steps
- Windows, macOS or Linux
- No coding needed
1. Your computer
Select your device from above, paste your GitHub username, and all the code to copy will be based on your selection below.
How it fits together
Click each boxA copy of the project under your own GitHub account. You can change it freely. You make it in Step 5.
PRE-FLIGHT CHECK
What you will need
Four free tools. Already have one? Run its check and tick it off.
- GitHub accountWhere the project lives. You copy it and share your changes here.CHECKgithub.com shows your avatar
- GitDownloads the project and tracks every change you make.CHECK
git --version - Node.js 20 to 22Runs the website on your computer. npm comes with it.CHECK
node -v - Code editorTo read and edit files. We suggest VS Code.CHECK
code --version
๐ก You do not need to know React or TypeScript to get the site running.
Create a GitHub account
2 minGitHub is where the recode hive code lives. If you already have an account, mark this step done and skip ahead.
- Go to github.com/signup.
- Pick a username you are happy to show employers. It becomes part of every link you share.
- Verify your email address.
Tip Add a profile photo and a one-line bio. Maintainers are more likely to review pull requests from real-looking profiles.Install Git
5 minGitA free tool that saves every version of your files and lets you share your changes. downloads the project and keeps track of your changes.
- Download Git for Windows from git-scm.com/download/win and run the installer.
- Keep the default options. They add Git to your terminal.
Or, if you use winget, open PowerShell (press the Windows key, type
PowerShell, press Enter) and run:PowerShellwinget install --id Git.Git -eThen tell Git who you are. Use the same email as your GitHub account:
Terminalgit config --global user.name "Your Name"git config --global user.email "you@example.com"Check it worked$ git --versiongit version 2.x.xYour version numbers may be different. That is fine. Install Node.js
5 minNode.jsLets your computer run JavaScript outside the browser. The recode hive website needs it to build and run. runs the website on your computer. You need version 20.9 or newer, up to 22. npm comes with it.
Install Node 22 with winget:
PowerShellwinget install OpenJS.NodeJS.22Or download the version 22 installer from nodejs.org (pick v22 in the version list) and keep the default options.
Check it worked$ node -v$ npm -vv22.x.x10.x.xAny Node version from 20.9 to 22 works. Install a code editor
3 minYou will read and edit files in a code editor. We suggest Visual Studio Code. It is free and works on every system.
Download VS CodeFork the project
1 minA forkYour own copy of a project on GitHub. You can change it freely without touching the original. is your own copy of recode hive on GitHub. You change your copy, then ask us to add your changes.
- Open github.com/recodehive/recode-website while signed in.
- Click Fork in the top right corner.
- Keep the name
recode-websiteand click Create fork.
recodehive / recode-websitePublic Star78 Fork203Click Fork. GitHub makes a copy under your account.When it finishes, your browser shows:
github.com/your-username/recode-websiteDownload your fork (clone)
2 minTo cloneDownload a copy of a GitHub project onto your computer, history included. means to download your fork to your computer. Open a terminal in the folder where you keep projects and run:
Terminalgit clone https://github.com/your-username/recode-website.gitcd recode-websiteType your GitHub username at the top of the page and this command fills itself in.
Open the project in your editor
1 minFrom inside the
recode-websitefolder, open VS Code:Terminalcode .Or open VS Code and use File, then Open Folder.
Install the project's dependencies
3 to 5 minThe website uses other people's code packages. This downloads them into a
node_modulesfolder. It takes a few minutes the first time.Terminalnpm installCheck it worked$ npm installadded โฆ packages in โฆThe exact number of packages will be different. Warnings in yellow are fine. Red ERR lines are not. Start the website
1 minStart the local development server:
Terminalnpm run startTry it here first$ npm run startA simulation. Nothing is running on your computer until you run the command in your own terminal.Open http://localhost:3000 in your browser. You are now running recode hive on your own computer.
Make a tiny change to see it work
2 minProve to yourself that it is really your copy:
- In VS Code, open
docs/getting_started.mdx. It is the page called "How to Contribute to Blogs". - Change one word in the first paragraph and save with Ctrl + S (Cmd + S on a Mac).
- Open localhost:3000/docs/how-to-contribute-to-blogs. The page reloads with your change in a second or two.
Do not worry about breaking anything. This is your copy. Nothing changes on recode hive until you open a pull request.To undo the experiment, run this in a second terminal in the same folder:
Terminalgit checkout -- docs/getting_started.mdx- In VS Code, open
Finish all 10 steps to unlock this
Tick each step as you complete it. Your progress is saved in this browser.
Still stuck?
Every step above has its own "Stuck on this step?" fixes. If none of them help, ask the community. Paste the exact error message and tell us which step you are on.
Your vote helps us improve our docs.
All our docs are open source. Found a typo, want to add detail or have a better explanation? Anyone can contribute.
Comments
Powered by GitHub Discussions