Skip to content

ryan65/shipit-2026

Repository files navigation

Contributing to Ship It 2026

Getting Access

Send your GitHub username to the repo owner to be added as a collaborator on github.com/ryan65/shipit-2026.

Once added, check your email or go to github.com/notifications and accept the invite.

Prerequisites

  • Node.js v18+
  • Git installed
  • A GitHub account

Setup

1. Clone the repo

SSH (recommended if you have a GitHub SSH key set up):

git clone git@github.com:ryan65/shipit-2026.git
cd shipit-2026

HTTPS (no SSH key needed):

git clone https://github.com/ryan65/shipit-2026.git
cd shipit-2026

2. Install dependencies

cd aut
npm install

3. Set up the data file

cp data/tasks.json.example data/tasks.json

4. Run the app

npm start

Open http://localhost:3000/main in your browser.

Project Structure

shipit-2026/
└── aut/
    ├── server.js          # Express server & all API routes
    ├── logger.js          # Winston logger configuration
    ├── data/
    │   └── tasks.json     # Local task store (git-ignored, create from .example)
    ├── logs/              # Runtime log files (git-ignored)
    └── public/            # Frontend HTML pages
        ├── main.html
        ├── history.html
        ├── new-task.html
        ├── edit-task.html
        ├── logs.html
        └── api-examples.html

Making Changes

  1. Create a new branch for your work:

    git checkout -b feature/your-feature-name
  2. Make your changes and commit:

    git add <files>
    git commit -m "Description of your change"
  3. Push your branch:

    git push origin feature/your-feature-name
  4. Open a Pull Request on GitHub against master.

About

No description, website, or topics provided.

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors