What you end up with
cc-deck running in your browser, on your own computer. It is free, and it stays free — there is no account, no trial and no subscription at the end of this.
- Time
- About 34 minutes
- Steps
- 15
- Cost
- Free
Before you start
These are one-time installs. If you have used Terminal before, you may have them already — the first step checks.
Install Git
Apple opens a small installer.
Type this into Terminal, then press Return.
xcode-select --installYou know this worked when: Git responds with a version number
Install Node LTS
Choose the macOS Installer (.pkg).
Open downloadYou know this worked when: Node responds with a version number
Install cc-deck
Open Terminal
Keep it open beside this page.
You know this worked when: Terminal is open
Check Git and Node
Git and the current Node LTS are required.
Type this into Terminal, then press Return.
git --version node --versionYou know this worked when: Git and Node respond with version numbers
Copy cc-deck to this Mac
Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.
cd ~ if [ ! -d cc-deck/.git ]; then git clone https://github.com/cyberneel/cc-deck.git fiYou know this worked when: A cc-deck folder appears
Open the cc-deck folder
Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.
cd ~ cd cc-deckYou know this worked when: Your terminal prompt is inside the cc-deck folder
Use the reviewed version
Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.
cd ~/cc-deck git checkout fec055d5cda50bdf9822f43ae5865aeae75e095cYou know this worked when: Git reports the reviewed commit
Install dependencies
Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.
cd ~/cc-deck npm installYou know this worked when: The command finishes without an error
Get a CCDECK_PASSWORD key
Sign in, create a key, and copy it.
Open the pageYou know this worked when: You have a key on your clipboard
Copy the env file
Then open .env and set CCDECK_PASSWORD.
Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.
cd ~/cc-deck cp .env.example .envYou know this worked when: .env has CCDECK_PASSWORD set
Get a CCDECK_SECRET key
Sign in, create a key, and copy it.
Open the pageYou know this worked when: You have a key on your clipboard
Copy the env file
Then open .env and set CCDECK_SECRET.
Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.
cd ~/cc-deck cp .env.example .envYou know this worked when: .env has CCDECK_SECRET set
Run cc-deck
Keep Terminal open.
Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.
cd ~/cc-deck npm run devYou know this worked when: localhost:8787 responds
Open it in your browser
If a different port was picked, open that one instead.
Open localhost:8787You know this worked when: The app loads in the browser
Try it
cc-deck should be open in your browser.
You know this worked when: cc-deck works
If something goes wrong
Nothing here can damage your computer, and every step can be run again safely. If a command fails, the usual cause is the step before it not having finished.
Still stuck? Tell us what happened and we will fix the guide. Include the step number and we can usually reproduce it.