Lets express

Application for building APIs with Express.js

Comes with:

• ES6 features/modules
• Bookshelf ORM and Knex migrations
• PostgreSQL (default) with support for MySQL and SQLite
• ESLint for code linting
• Application configuration using dotenv
• Pretty error reporting using youch

---

Prerequisite

• Node.js - 8.9.2 or above
• Yarn - 1.3.2 or above
• NPM - 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 <application-name>
$ cd <application-name>
$ 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 first.

License

lets-express is under MIT License.