https://github.com/cham11ng/lets-express

Building APIs with Express.js, Node.js
https://github.com/cham11ng/lets-express

api bookshelf database dotenv es6 eslint jwt knex nodejs postgres react reactjs yarn youch

Last synced: 6 months ago
JSON representation

Building APIs with Express.js, Node.js

• Host: GitHub
• URL: https://github.com/cham11ng/lets-express
• Owner: cham11ng
• License: mit
• Created: 2017-12-07T10:03:27.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-12-27T08:04:24.000Z (almost 8 years ago)
• Last Synced: 2025-03-24T17:21:16.299Z (7 months ago)
• Topics: api, bookshelf, database, dotenv, es6, eslint, jwt, knex, nodejs, postgres, react, reactjs, yarn, youch
• Language: JavaScript
• Homepage:
• Size: 118 KB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Lets express

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

Application for building APIs with [Express.js](http://expressjs.com/)

Comes with:

* [ES6](http://babeljs.io/learn-es2015/) features/modules

* [Bookshelf](http://bookshelfjs.org/) ORM and [Knex](http://knexjs.org/) migrations

* PostgreSQL (default) with support for MySQL and SQLite

* [ESLint](http://eslint.org/) for code linting

* Application configuration using [dotenv](https://github.com/motdotla/dotenv)

* Pretty error reporting using [youch](https://github.com/poppinss/youch)

---

## Prerequisite

* [Node.js](https://yarnpkg.com/en/docs/install) - 8.9.2 or above

* [Yarn](https://yarnpkg.com/en/docs/install) - 1.3.2 or above

* [NPM](https://docs.npmjs.com/getting-started/installing-node) - 5.6.0 or above

## Setup

Clone the repository, install the dependencies and get started right away.

    $ git clone git@github.com:cham11ng/lets-express.git 

    $ cd 

    $ yarn

    

Make a copy of `.env.example` as `.env` and update your application details and database credentials. Now, run the migrations and seed the database.

    $ yarn migrate

    $ yarn seed

Finally, start the application.

    $ yarn start:dev (For development)

    $ yarn start (For production)

Navigate to http://localhost:8000/api/ to verify installation.

## Contributing

For contribution and feature requests, please create an [issue](https://github.com/cham11ng/lets-express/issues) first.

## License

lets-express is under [MIT License](LICENSE).