Code Monkey home page Code Monkey logo

generate-node-project's Introduction

generate-node-project

Generate a complete NodeJS app (API) with babel, jest, Sequelize, JWT already configured for you.

Generate Node Project works on macOS, Windows, and Linux.
If something doesn’t work, please file an issue.
If you have questions or need help, please ask via email: [email protected]

Installation

npm i -g generate-node-project

or

yarn global add generate-node-project

Quick Overview

generate-node-project new_node
cd new_node
npm start

Get Started Immediately

You don’t need to install or configure tools like babel, eslint, sequelize, jest, mocha, mongodb, etc....
They are pre-configured and working, so that you can focus on the code.

Create a project, and you’re good to go.

Creating an App

You’ll need to have Node 8.16.0 or Node 10.16.0 or later version on your local development machine

To create a new app, you may choose one of the following methods:

generate-node-project

generate-node-project new_node

OR create-node-api

create-node-api new_node

It will create a directory called new_node inside the current folder.
Inside that directory, it will generate the initial project structure and install the required dependencies:

new_node
├── README.md
├── node_modules
├── package.json
├── .gitignore
├── .eslintrc
├── .jest.config.js
├── .env
├── app.js
├── index.js
├── __tests__
└── src
    ├── config
    ├── controllers
    ├── routes
    ├── models
    ├── migrations
    └── seeders

Now all the configurations and folder structures are done for you.
Once the installation is done, you can open your project folder:

cd new_node

Inside the newly created project, you can run some existing commands:

npm start or yarn start

Runs the app in development mode.
And it will be available on http://localhost:3000.

npm test or yarn test

Runs the test.

More Commands:

Generate basic NodeJs API: javascript

generate-node-project app_name --skip

Generate basic NodeJs API: typscript

generate-node-project app_name --template=typescript

View all available commands

generate-node-project --help

generate-node-project's People

Contributors

abayo-luc avatar nkfab avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.