{"id":19558331,"url":"https://github.com/sbimochan/express_play","last_synced_at":"2025-02-26T08:18:43.259Z","repository":{"id":106952526,"uuid":"113882827","full_name":"sbimochan/express_play","owner":"sbimochan","description":null,"archived":false,"fork":false,"pushed_at":"2020-07-21T09:32:02.000Z","size":6732,"stargazers_count":0,"open_issues_count":8,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-08T22:03:53.910Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sbimochan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-12-11T16:35:28.000Z","updated_at":"2017-12-13T14:32:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"123191fc-37a0-4227-bfda-f2eb91d92dbf","html_url":"https://github.com/sbimochan/express_play","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbimochan%2Fexpress_play","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbimochan%2Fexpress_play/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbimochan%2Fexpress_play/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbimochan%2Fexpress_play/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sbimochan","download_url":"https://codeload.github.com/sbimochan/express_play/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240814857,"owners_count":19861958,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T04:46:49.193Z","updated_at":"2025-02-26T08:18:43.208Z","avatar_url":"https://github.com/sbimochan.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Express API ES6 Starter](https://i.imgur.com/qeAbxtQ.png \"Express API ES6 Starter\")\n\n[![Code Climate](https://codeclimate.com/github/mesaugat/express-api-es6-starter/badges/gpa.svg)](https://codeclimate.com/github/mesaugat/express-api-es6-starter)\n[![Build Status](https://travis-ci.org/mesaugat/express-api-es6-starter.svg?branch=master)](https://travis-ci.org/mesaugat/express-api-es6-starter)\n[![Codecov](https://codecov.io/gh/mesaugat/express-api-es6-starter/branch/master/graph/badge.svg)](https://codecov.io/gh/mesaugat/express-api-es6-starter)\n\nStarter application for building APIs with [Express.js](http://expressjs.com/)\n\nComes with:\n\n* [ES6](http://babeljs.io/learn-es2015/) features/modules\n* ES7 [async](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function)/[await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)\n* [Bookshelf](http://bookshelfjs.org/) ORM and [Knex](http://knexjs.org/) migrations\n* PostgreSQL (default) with support for MySQL and SQLite\n* API documentation using [swagger-ui](https://www.npmjs.com/package/swagger-ui) and [swagger-jsdoc](https://www.npmjs.com/package/swagger-jsdoc)\n* [ESLint](http://eslint.org/) for code linting\n* Request validation using [Joi](https://www.npmjs.com/package/joi)\n* Code formatting using [Prettier](https://www.npmjs.com/package/prettier)\n* Logging using [winston](https://www.npmjs.com/package/winston)\n* Application configuration using [dotenv](https://www.npmjs.com/package/dotenv)\n* Tests using [mocha](https://www.npmjs.com/package/mocha), [supertest](https://www.npmjs.com/package/supertest) and [chai](https://www.npmjs.com/package/chai)\n\n---\n\n## Prerequisite\n\n* [Node.js](https://yarnpkg.com/en/docs/install) - 6.9.0 or above\n* [Yarn](https://yarnpkg.com/en/docs/install) - 1.0.0 or above\n* [NPM](https://docs.npmjs.com/getting-started/installing-node) - 3.10.8 or above\n\n## Setup\n\nClone the repository, install the dependencies and get started right away.\n\n    $ git clone git@github.com:mesaugat/express-api-es6-starter.git \u003capplication-name\u003e\n    $ cd \u003capplication-name\u003e\n    $ rm -rf .git\n    $ yarn   # or npm install\n\nMake a copy of `.env.example` as `.env` and update your application details and database credentials. Now, run the migrations and seed the database.\n\n    $ yarn migrate\n    $ yarn seed\n\nFinally, start the application.\n\n    $ yarn start:dev (For development)\n    $ yarn start (For production)\n\nNavigate to http://localhost:8848/api-docs/ to verify installation.\n\n## Setup Using Docker\n\nUse [docker-compose](https://docs.docker.com/compose/) to quickly bring up a stack with pre-configured Postgres database container. Data is ephemeral and containers will disappear when stack is removed.\n\nSpecific configuration for Docker is in `.env.docker`\n- `0.0.0.0` as `$APP_HOST` to expose app on Docker network interface\n- Pre-configured Postgres settings - can be updated to point to another Postgres host\n\nBring up stack,\n\n    $ docker-compose up\n\nNavigate to http://localhost:8848/api-docs/ to verify application is running from docker.\n\nBring down stack,\n\n    $ docker-compose down\n\n## Using MySQL instead of PostgreSQL\n\nInstall the [mysql](https://www.npmjs.com/package/mysql) driver first. Update these lines `DB_CLIENT='pg'` and `DB_PORT='5432'` in your .env file to `DB_CLIENT='mysql'` and `DB_PORT='3306'` respectively.\n\nYou can remove the [pg](https://www.npmjs.com/package/pg) driver if you like to.\n\n    $ yarn add mysql\n    $ yarn remove pg\n\nThat's it, you are ready to roll.\n\n## Tests\n\nTo run the tests you need to create a separate test database. Don't forget to update your `.env` file to include the name of the test database and run the migrations.\n\n    $ NODE_ENV=test yarn migrate:latest\n    $ yarn test\n\n## Contributing\n\nFor contribution and feature requests, please create an [issue](https://github.com/mesaugat/express-api-es6-starter/issues) first.\n\n## License\n\nexpress-api-es6-starter is under [MIT License](LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsbimochan%2Fexpress_play","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsbimochan%2Fexpress_play","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsbimochan%2Fexpress_play/lists"}