Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

hello-world

Important first clarification

You do not have to use /workspace/hello-world on your personal computer. That path is commonly used in cloud/dev containers. On your own machine, you can use any folder, for example:

  • ~/workspace/hello-world (recommended)
  • ~/Documents/hello-world

So yes: if you cannot find /workspace, you can create your own workspace folder locally.


Beginner guide (zsh) — create folder, find repo, run app

0) Open terminal and switch to zsh

zsh

1) Create your own workspace folder (safe on any machine)

mkdir -p ~/workspace
cd ~/workspace
pwd

You should now see a path like /home/<you>/workspace (Linux) or /Users/<you>/workspace (macOS).

2) Place this repository in that folder

Option A: Clone from GitHub (best)

cd ~/workspace
git clone https://github.com/<your-user>/<your-repo>.git hello-world
cd hello-world

Option B: You downloaded ZIP

cd ~/Downloads
unzip hello-world.zip
mv hello-world ~/workspace/hello-world
cd ~/workspace/hello-world

3) Verify repository is complete

pwd
ls -la
ls -la .git

You should see:

  • Cats/
  • scripts/
  • README.md
  • IMPLEMENTATION_PACKAGE.md
  • .git/

You can also run:

./scripts/check_repo.zsh

4) Start the app server

./scripts/run_app.sh

Open in browser:

  • http://localhost:8080/Cats/
  • fallback: http://localhost:8080/Cats/index.html

5) Quick smoke test

In another terminal tab:

cd ~/workspace/hello-world
./scripts/test_app.sh

6) If you specifically want /workspace/hello-world

On Linux with permission to create under root:

sudo mkdir -p /workspace
sudo chown -R "$USER":"$USER" /workspace
mkdir -p /workspace/hello-world

Then clone into it:

git clone https://github.com/<your-user>/<your-repo>.git /workspace/hello-world

If you do not have sudo, just keep using ~/workspace/hello-world.


Helper script to create workspace folder

This command creates ~/workspace and checks whether repo exists there:

./scripts/setup_repo_folder.sh

Optional custom location:

./scripts/setup_repo_folder.sh ~/Documents

Notes

  • This is a front-end prototype with simulated sync behavior.
  • Backend/database implementation details are in IMPLEMENTATION_PACKAGE.md.

Releases

Packages

Contributors

Languages