1.0.1 โ€ข Published 2 years ago

create-express-api-template v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

create-express-api-template ๐Ÿ“ฆ

This is an npm package that I've created that will clone my express-api-template repo into any project to provide a ready to use API template to start creating an express API.

TODO

  • Figure out how to use node to run terminal commands that will clone the express-api-template repo. โŒจ๏ธ

  • Maybe take this opportunity to learn about writing some tests and to test the project. ๐Ÿ”ฌ

  • Test the project to make sure that it works properly. ๐Ÿงช

  • Configure package.json correctly to run script

  • Publish the package to npm. ๐Ÿ“•

About

This is a repository for an npm package create-express-api-template which clones the project in the express-api-template, which is a template for a basic express project with logging, tests, and some basic routes. For a complete list of all of the dependencies and things that are set up in the project, follow the link to the github page.

Usage

Global Install

To install the package globally on the machine, you can run npm install create-express-api-template -g. Then, to actually use the package, you can run create-express-api-template <project-name> which will clone the express-api-template project into a directory with the <project-name> and install all of the necessary dependencies for the project to run.

npx

You can also install this package using npx. To do so, run npx create-express-api-template <project-name> which will clone the express-api-template in a directory with the <project-name> and install all of the dependencies in the express-api-template package.json.