Getting Started & Setup

Prerequisites

You'll need the following before you can get started developing SpecDB:

• a *nix-like operating system, such as Linux or Mac (track Windows support here).
• Node.js and npm. The way to install these varies by platform. You will need a pretty recent version (probably at least 6?) in order to support the es6 features used.
• Comfortability with the command line. You will need to use the command line to set up, build, and add parts to SpecDB, and it will be a challenge if you don't know the basics.

Downloading and Setting up

1. If you are planning to make changes, you will want to fork the repo before cloning it, so do that. If you just want to set it up locally without making changes, you don't need to do this.
2. Clone your forked repo. Example command: git clone https://github.com/myAccountName/SpecDB (you'd want to run this in terminal/Command Prompt after cd'ing to wherever you want it to be).
3. cd into the newly cloned directory: cd SpecDB
4. Switch to development branch: git checkout dev
5. Install required npm modules: npm i
6. Test that everything is ok: npm test. If this fails, try it again. If it still fails, then more likely than not you are running an outdated version of Node.js. If you are using the latest version, open an issue.
7. Build: npm run build

After this, you should have a working SpecDB setup! Test it by going to file:///path/to/wherever/you/downloaded/SpecDB/public/index.html, and you should see it!

Rebuilding

Every time you make changes to specs, js, css, or anything else, you will want to run npm run build to rebuild, otherwise you will not see the changes.