# hammer-starter

> A Node.js, Express, MySQL, Passport, Jade starter kit.

Latest version **0.1.0** (published 2015-11-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install hammer-starter
pnpm add hammer-starter
yarn add hammer-starter
bun add hammer-starter
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2015-11-28 |
| First published | 2015-11-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 33 |
| Author | Jon Kuperman |
| Maintainers | jkup |
| Keywords | Express, MySQL, Passport, Jade |

## Links

- npm: https://www.npmjs.com/package/hammer-starter
- Repository: https://github.com/jkup/hammer
- Homepage: https://github.com/jkup/hammer#readme
- Issues: https://github.com/jkup/hammer/issues
- npm.io page: https://npm.io/package/hammer-starter

## Dependencies (10)

- [jade](https://npm.io/package/jade.md) ^1.11.0
- [mysql](https://npm.io/package/mysql.md) ^2.9.0
- [express](https://npm.io/package/express.md) ^4.13.3
- [bcryptjs](https://npm.io/package/bcryptjs.md) ^2.3.0
- [passport](https://npm.io/package/passport.md) ^0.3.2
- [body-parser](https://npm.io/package/body-parser.md) ^1.14.1
- [connect-flash](https://npm.io/package/connect-flash.md) ^0.1.1
- [cookie-parser](https://npm.io/package/cookie-parser.md) ^1.4.0
- [passport-local](https://npm.io/package/passport-local.md) ^1.0.0
- [express-session](https://npm.io/package/express-session.md) ^1.12.1

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2015-11-28

## README

[![Build Status](https://travis-ci.org/jkup/hammer.svg?branch=master)](https://travis-ci.org/jkup/hammer)

# Hammer

A Node.js, Express, MySQL, Passport, Jade starter kit.

## Screenshot

![Hammer Homepage Screenshot](/hammer_screenshot.png "Hammer Screenshot")

## Installation

    git clone https://github.com/jkup/hammer.git
    cd hammer
    npm install

### MySQL

First you'll need to create a database, name it anything you'd like but you'll need the name later.

    $ mysql -uroot -p
    mysql> CREATE DATABASE YOUR_DATABASE;

Inside this database create a 'users' table that contains the following fields:

    mysql> CREATE TABLE `YOUR_DATABASE`.`users` (
    `id` INT NOT NULL AUTO_INCREMENT,
    `username` VARCHAR(45) NOT NULL,
    `email` VARCHAR(255) NOT NULL,
    `password` VARCHAR(255) NOT NULL,
    PRIMARY KEY (`id`),
    UNIQUE INDEX `username_UNIQUE` (`username` ASC),
    UNIQUE INDEX `email_UNIQUE` (`email` ASC));

You'll then need to edit app/config/connection.js and enter your credentials.

    const connection = mysql.createConnection({
      host     : 'localhost',
      user     : 'YOUR_USERNAME',
      password : 'YOUR_PASSWORD',
      database : 'YOUR_DATABASE'
    });

### Server

Now you can edit app/config/routes/default-routes.js and replace the title and message key with whatever you'd like to see as the home page title and header message.

### Start

Now just run:

    npm start

And off you go!

### Testing

A testing framework is already setup in the test folder. To run all tests, simply type:

    npm test


## Libraries

Hammer makes use of a lot of open source libraries. They are probably your best bet for getting specific help with your application. The current list of technologies can be found here.

+ [Node.js](https://nodejs.org/en/)
+ [Express.js](http://expressjs.com/)
+ [jQuery](https://jquery.com/)
+ [jade](http://jade-lang.com/)
+ [Passport](http://passportjs.org/)
+ [MySQL](https://www.mysql.com/)
+ [bcrypt](https://www.npmjs.com/package/bcryptjs)

---
_Source: https://npm.io/package/hammer-starter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._