iFixit / iFixit/pulldasher

Installation instructions are pretty vague

Open
#145 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
37
Forks
10
Avg merge
5d 4m
Merged PRs (30d)
1

Description

I'm having a bit of trouble getting pulldasher to run locally. The instructions in the readme and config.js sort of gloss over some of the setup instructions and required knowledge.

   // The usual MySQL stuff. Like every other MySQL webapp, basically.
   // You will need to source the `schema.sql` file in the database to create
   // all the tables that Pulldasher expects.
   mysql: {
      host: 'mysql remote host URL',
      db:   'database name',
      user: 'username',
      pass: 'password'
   },

Not sure what to put in here. Maybe we could be a little more descriptive in how we connect this to docker?

Trying to help out with some design tweaks here and there but can't get it running 😢

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the README and config.js installation guidance, then inspect schema.sql to understand the required database setup. Document the values needed for the MySQL connection and how to connect the application to Docker; done means a newcomer can follow the instructions to run Pulldasher locally.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, mysql
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.