https://github.com/kwhitley/express-server
Quick express server with all the basics to get you off the ground and injecting your APIs...
https://github.com/kwhitley/express-server
Last synced: 3 months ago
JSON representation
Quick express server with all the basics to get you off the ground and injecting your APIs...
- Host: GitHub
- URL: https://github.com/kwhitley/express-server
- Owner: kwhitley
- Created: 2019-03-06T17:30:29.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-06T21:15:14.000Z (over 6 years ago)
- Last Synced: 2024-04-14T05:46:36.602Z (about 1 year ago)
- Language: JavaScript
- Size: 116 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
A simplified Express.js environment to serve server + client code.
=======
#### Supports Redis or built-in memory engine with auto-clearing.
# Includes
- [x] gzip compression
- [x] body parsing for form data
- [x] favicon serving
- [x] sessions
- [x] cookies
- [ ] authentication
# Installation
```bash
yarn add @supergeneric/express-server
```
# Usage
```js
/* import instantiated express app from our starter kit...
this is a full-fledged express app, ready to accept middleware,
plugins, routers, etc. We've added the .start() method to fire
up the server directly, although you could always start it any other way
you like.
*/
import app from '@supergeneric/express-server'
app.start()
```
# Examples
### Usage with custom API
###### index.js
```js
import express from '@supergeneric/express-server'
import api from './api'
const app = express() // same way you instantiate express
app.use('/api', api)
app.start()
```
###### api.js
```js
import express from 'express'
const app = express()
// example route... will be callable from /api/foo
app.get('/foo', (req, res) => {
res.json({
success: true,
path: req.path,
})
})
export default app
```
# What goes on under the hood?
This library basically abstracts the basic setup of the express http server, complete with
static routing, compression, sessions, cookies, etc. It's basically super shorthand for something like the following:
```js
require('dotenv').config()
// include other main deps
import express from 'express'
import bodyParser from 'body-parser'
import cookieParser from 'cookie-parser'
import compression from 'compression'
import session from 'express-session'
import sslRedirect from 'heroku-ssl-redirect'
import path from 'path'
import http from 'http'
import fs from 'fs'
import favicon from 'serve-favicon'
import { clientPath } from './paths'
// instantiate express
const app = express()
const isProduction = process.env.NODE_ENV === 'production'
// force SSL on production
app.use(sslRedirect([
'production',
]))
app.use(session({
secret: 'secret: 'Puppies are the new secretness. ' + new Date(),' + new Date(),
resave: false,
saveUninitialized: true,
}))
app.use(cookieParser())
app.use(bodyParser.json())
app.use(bodyParser.urlencoded({ extended: false }))
app.use(compression())
// static serving of assets, files, scripts
console.log(`serving static content from ${clientPath}`)
app.use(express.static(clientPath))
// serves favicon
app.use(favicon(path.join(__dirname, 'favicon.ico')))
// all unmatched get 404
app.get('*', (req, res) => {
res.sendStatus(404)
})
const server = http.createServer(app)
console.log(`Express server @ http://localhost:3000 (${isProduction ? 'production' : 'development'})\n`)
server.listen(3000)
```