api-starter

Everyone needs an API these days, right?

Requirements

• Node.js 9+
• MySQL

Dependencies

• Express web framework
• Knex SQL query builder
• Ava for concurrent tests
• Babel JS transpiler
• Joi schema validator
• JWT for stateless authentication

Folder structure

Folders look like this:

.
├── src
│   ├── api         # API modules (i.g. user, auth, etc.) 
│   ├── db          # Database connection module
│   ├── job         # Recurring jobs
│   ├── middleware  # Express middlewares
│   ├── migration   # Database migrations
│   ├── model       # Application model classes
│   ├── seed        # Database seeds
│   ├── schema      # Schemas
│   ├── script      # Script files (sql, bash, etc.)
│   ├── util        # Resuable modules
│   └── index.js    # Application entry file
└── test            # Test files

Note: some files were omitted for simplicity.

Get started

1. Clone the repo:

git clone https://github.com/ruanmartinelli/api-starter.git <NEW_NAME>
cd <NEW_NAME>

# make it yours:
rm -rf .git
git init

2. Install dependencies

yarn install

3. Create a .env file (remember to add your keys)

mv .env.example .env

4. Run migrations:

npm run db:latest

Note: this assumes you have MySQL installed

5. Run

npm run dev

npm Scripts

Start the server in Production mode:

npm start 

Start the server in Development mode:

npm run dev 

Show lint errors:

npm run lint

Show lint errors and fix minor issues:

npm run lint:fix

Run AVA tests:

npm t

Run AVA tests in watch mode:

npm run test:watch

Generate API documentation:

npm run docs

Conventions

• Folder and file names are always on singular (eg. user.js, script/ )
• function x() { } instead of const x = () => {}
• All Standard rules

License

MIT © Ruan Martinelli