panfilo-express-template v3.2.2

Amaury Express Template

Usage

$ npx panfilo-express-template my-app
$ cd my-app
$ npm run dev

Highlights

• Amaury Express Template
  • Usage
  • Highlights
  • Usage with options
  • Templates
  • Main folders
  • .env file
  • folders
  • Scripts
  • Libraries

Usage with options

$ npx use-express-template --help 

    Usage
   $ create-express-template <FolderName>

   FolderName can be:
     Folder name can be anything without a space

 Options
      --template            Name of the template(default:TypeScript)
      --default(-d)         Use default template
      --yarn(-y)            Use Yarn

 Examples
   $ create-express-template
   $ create-express-template my-app
   $ create-express-template my-app -d
   $ create-express-template my-app --template=TypeScript -y
   $ create-express-template my-app --template=ts -y

The folderName and the template will be prompted to the user via the interactive ui in case these are not specified.

Using the default option will use TypeScript as the template.

If you want to use yarn as your package manager(by default we use npm), specify the yarn option.

The available templates(you can use the full names or the initials) are listed here.

Templates

Note : The template option can take any of these template values or their initials.

All the values for the database port and name and other settings are stored in the .env file which you can change to whatever value which you want to use.

Main folders

• You will start with 3 folders:
  • src: Main files
  • public: All static files here
  • tests: Make your tests here

.env file

We use dotenv to manage our environment variables. Please note that all the ports and database names can be changed in the .env file to the value you want to use.

• Configure your MongoDB with these variables:
  • PORT: The port you will use for your project, this is optional, by default will run in port 3000.
  • PRODUCTION_DB: Your MongoDB database url for production
  • DEV_DB: Your MongoDB database url for development
  • TEST_DB: Your MongoDB database url for testing
  • SECRET_JWT_SEED: Your secret seed for JWT

Note: If you dont configure an url for production and you deploy your project to production, you will have an error; same for other database urls here.

folders

• You have a set of folders to begin with, these are:
  • controllers: Save here the controllers for your app
  • database: Here lays the database configuration
  • helpers: Save halper files
  • middlewares: Save custom middlewares here
  • models: Save the models for your controllers
  • router: Save the router configurations here

Scripts

• "dev": run a nodemon server with hot reload
• "build": compile typescript into build files (Just for TypeScript template)
• "start": runs a node server for production
• "test": runs Jest for testing with hot reload

Libraries

Here are the external libraries that the template use:

• bcrypt.js
• cors
• dotenv
• express
• express-validator
• jsonwebtoken
• Moment.js
• Mongoose
• Jest
• Supertest
• TypeScript