AKCS
AKCS / developer docs Beginner mode

No experience required

Start
building.

A zero-to-first-pull-request guide for AKCS members. Learn the language, set up your computer, choose a real club project, and ship a small change.

Start here

01 / Your path

From curious to contributor.

Work through these in order. You do not need to memorize every command—understand the goal, then use the examples when you need them.

01

Create your GitHub account

Choose a professional username, verify your email, and add a short profile. Your profile becomes a public portfolio of what you build.

Create an account
02

Install your tools

Install Git, Node.js, and VS Code. Git tracks changes, Node runs our TypeScript projects, and VS Code is where you edit files.

Install Git
03

Pick a repository

Open an AKCS project, read its README, and check the Issues tab. Start with a small documentation, design, or bug-fix task.

Browse the organization
04

Make your first contribution

Create a branch, make one focused change, test it, commit it, push it, and open a pull request explaining what you changed.

See open issues

02 / Local setup

Run the site.

Open Terminal on macOS/Linux or PowerShell on Windows. Run one line at a time. If a command fails, read the last error line and ask for help.

Before you startInstall Git and the current Node.js LTS release. Never paste passwords, API keys, or private tokens into code or GitHub.
terminalcopy line by line
  1. 01Clone the websitegit clone https://github.com/Ardrey-Kell-Computer-Science-Club/ArdreyCSClub.git
  2. 02Enter the foldercd ArdreyCSClub
  3. 03Install packagesnpm install
  4. 04Create your branchgit switch -c your-name/short-change
  5. 05Start the websitenpm run dev

03 / GitHub language

Know the workflow.

01
Repository
A project folder tracked by GitHub, including its code and history.
02
Clone
Download a working copy of a repository to your computer.
03
Branch
A safe lane where you can make changes without affecting main.
04
Commit
A saved checkpoint with a short explanation of what changed.
05
Pull request
A request for maintainers to review and merge your changes.
06
Issue
A tracked bug, task, question, or feature idea.
STEP 1

Choose an issue

STEP 2

Create a branch

STEP 3

Make + test

STEP 4

Commit + push

STEP 5

Open a PR

04 / Real club code

Choose a project.

View organization
01

TypeScript · website

ArdreyCSClub

The official AKCS website. A great place to practice React, Next.js, responsive design, and accessible UI.

02

TypeScript · automation

AKCSDiscordBot

The code behind the official club Discord bot. Learn commands, events, APIs, and practical automation.

03

TypeScript · student platform

TutorWeb3

A tutoring platform for AK computer science students to schedule support and find academic resources.

04

TypeScript · learning

AKCS Wiki

Guides and resources for computer science topics, hackathons, competitions, and club projects.

05 / Getting unstuck

Questions are part of coding.

Before asking, copy the exact error, note the command you ran, and explain what you expected. Open a GitHub issue for project problems or bring your laptop to an AKCS meeting for hands-on help.

Exact error message Steps to reproduce What you already tried
Ask on GitHub
Docs for first-time contributorsArdrey Kell Computer Science Club