Start with the Functional Spec which also gives the backstory for this project.

Follow the steps below. Please make a pull request if any of this isn't super straightforward or you need to do additional steps to get up and running!

Start it with running either brew services start postgresql to have it as a background service that will restart if you reboot or pg_ctl -D /usr/local/var/postgres start to start it just once.

Start it with the command sudo service postgresql start to have it run as a background service that will restart if you reboot or sudo -u postgres /usr/lib/postgresql/10/bin/pg_ctl -D /var/lib/postgresql/10/main -l logfile start which runs the script as the automatically created PostgreSQL user account to start it just once.

Confirm that postgresql is running on localhost:5432. If you run pg_isready you should see /tmp:5432 - accepting connections.

Run the following to create a user and a database. If prompted for a password, use the password iwill.

createuser -P iwill
createdb -O iwill commitsto

sudo -u postgres createuser -P iwill
sudo -u postgres createdb -O iwill commitsto

2.1 Install Node 8.x LTS with the binary or installer or by using a package manager.

Create a .env file in the root of the project directory with the following contents, replacing <yourname> with your name:

APP_PORT=5000

DATABASE_URL=postgres://iwill:iwill@localhost:5432/commitsto

If you are running the app for the first time, or have recently pulled changes, you should run npm install

• Build server in watch mode: npm run dev:build:server
• Build client in watch mode: npm run dev:build:client
• Start server: npm run dev:server

Just navigate to localhost:5000/

If you have problems connecting to the application via your browser, check that you have made the necessary changes to the /etc/hosts file for the subdomain you are using.
You may also need to flush the DNS cache to ensure those changes are recognized.

On Ubuntu, you can use the name service cache daemon (nscd) to flush the DNS cache.

sudo apt-get install nscd
sudo service nscd restart

On MacOS, the command to flush the DNS cache will depend on your exact OS level. See How To Clear Your DNS Cache for detailed recommendations by OS version.

Run Mocha tests with npm test.

We're using the Chai assertion library and Sinon for spying/stubbing. You can run tests in watch mode to get results nearly instantly on save with npm run test:watch

The structure and naming inside the test/ folder should mirror the root structure and file names. Writing code with well-contained classes or functions will be the most straightforward to unit test.

Issue tracking labels follow the Beeminder Label Ontology. The following abbreviations, acronyms, and amusing shorthands are employed in service of bug zapping and feature enhancing: