2.0.4 • Published 2 years ago

create_nem_server v2.0.4

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

Create NEM Server

Create Node-Express server with MongoDB (mongoose) database.

Create NEM server works on macOS, Windows, and Linux. If something doesn’t work, please file an issue.

Quick Overview

npx create_nem_server my_server
cd my_server
npm start or yarn start

Get Started Immediately

You don’t need to install or configure tools like Express, Bcryptjs, Jsonwebtoken, Mongoose. They are already installed so that you can focus on the code. Also, You don’t need to create User Model and Router. It is already created.

You will need just two things, MongoDB connection string and password. Just copy that and past it on the .env file with this format.

PASSWORD = your_password
CON_STRING = mongodb+srv://your_name:{&PASSWORD&}@portfolios.s9uuh.mongodb.net/db_name?retryWrites=true&w=majority

And now, you’re good to go.

Creating an Server

You’ll need to have Node 12.0.0 or later version on your local development machine. We recommend using the latest LTS version. You can use nvm (macOS/Linux) or nvm-windows to switch Node versions between different projects.

To create a new server, you may follow the following methods:

npx

npx create_nem_server my_server

(npx is a package runner tool that comes with npm 5.2+ and higher, see instructions for older npm versions)

Folder Structure

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

my-server
├── README.md
├── app.js
├── node_modules
├── package.json
├── .gitignore
├── config
│   ├── .env
├── controler
│   ├── user.js
├── db
│   ├── database.js
├── middleware
│   ├── error.js
│   ├── auth.js
├── model
│   ├── User.js
├── route
    ├── user.js

No configuration or complicated folder structures, only the files you need to build your server app. Once the installation is done, you can open your project folder:

cd my_server

Inside the newly created project, you can run some built-in commands:

npm start or yarn start

Runs the app in development mode. Open http://localhost:5000 to view it in the browser.

Philosophy

  • No Configuration Required: You don't need to configure anything. A reasonably good configuration of both development and production builds is handled for you so you can focus on writing code.