Nodstarter

Table of Contents

• General Info
• Technologies
• Initial Code
• Project Structure
• Code Example
• Sign In API Call Example
• Environment Variables
• Setup
• Before Running
• Demo
• New Ideas
• Future Plans
• Contributing
• License Summary
• NPM Statistics
• Project Based

General Info

Nodstarter provides a framework for developing secure RESTful APIs quickly. It includes pre-configured routers, services, and models, allowing developers to focus on writing business logic rather than setup and configuration.

Technologies

• Node.js: JavaScript runtime for building scalable network applications.
• Express: Web framework for Node.js.
• MongoDB: NoSQL database for storing data.
• Mongoose: ORM for MongoDB.
• Lodash: Utility library for JavaScript.
• Morgan: HTTP request logger middleware.
• Body-parser: Middleware for parsing request bodies.
• Method-override: Middleware to allow HTTP verbs such as PUT or DELETE.
• Bcrypt: Library for hashing passwords.
• Express-jwt: Middleware for JWT authentication.
• Jsonwebtoken: Library for signing and verifying JSON Web Tokens.
• Cors: Middleware for enabling Cross-Origin Resource Sharing.
• Nodemon: Utility for auto-reloading the server during development.
• Testing Libraries: Supertest, Chai, and Mocha for testing.

Initial Code

Nodstarter includes models for users, posts, and categories, with predefined relationships:

• User to Posts: One-to-many.
• Posts to Categories: Many-to-many.

These components are organized into routers, controllers, and models to provide a clear structure for API development.

Project structure

├── index.js
├── package.json
├── scripts
│   └── post_install.js
└── server
    ├── api
    │   ├── categories
    │   │   ├── controller.js
    │   │   ├── model.js
    │   │   └── router.js
    │   ├── index.js
    │   ├── posts
    │   │   ├── controller.js
    │   │   ├── model.js
    │   │   └── router.js
    │   └── users
    │       ├── controller.js
    │       ├── model.js
    │       └── router.js
    ├── auth
    │   ├── controller.js
    │   ├── index.js
    │   └── routers.js
    ├── config
    │   ├── development.js
    │   ├── index.js
    │   ├── production.js
    │   └── testing.js
    ├── index.js
    ├── middleware
    │   ├── err.js
    │   └── index.js
    └── util
        ├── createRouter.js
        └── logger.js

Code example

This is the configuration to the JWT token to the user

JWT configuration

1const expressJwt = require('express-jwt');
2const config = require('../config');
3const logger = require('../util/logger');
4const jwt = require('jsonwebtoken');
5const checkToken = expressJwt({
6    secret: config.secrets.jwt
7});
8const User = require('../api/users/model');
9exports.decodeToken = () => {
10    return (req, res, next) => {
11        if (req.query && req.query.hasOwnProperty('access_token')) {
12            req.headers.authorization = 'Bearer ' + req.query.access_token;
13        }
14        checkToken(req, res, next);
15    };
16};
17
18exports.getFreshUser = () => {
19    return (req, res, next) => {
20        User.findById(req.user._id)
21            .then((user) => {
22                if (!user) {
23                    res.status(400).send('Unanuthorized');
24                } else {
25                    req.user = user;
26                    next();
27                }
28            }, (err) => {
29                next(err);
30            });
31    };
32};
33
34exports.verifyUser = () => {
35    return (req, res, next) => {
36        var username = req.body.username;
37        var password = req.body.password;
38
39        if (!username || !password) {
40            res.status(400).send('You need a username and password');
41            return;
42        }
43
44        User.findOne({
45                username: username
46            })
47            .then((user) => {
48                logger.log('the selected user from DB: ' + user);
49                if (!user) {
50                    logger.log('No user with the given username');
51                    res.status(401).send('Invalid username or password');
52                } else if (!user.authenticate(password)) {
53                    logger.log('Invalid password');
54                    res.status(401).send('Invalid username or password');
55                } else {
56                    req.user = user;
57                    next();
58                }
59            }, (err) => {
60                next(err);
61            });
62    };
63};
64
65exports.signToken = (id) => {
66    logger.log("id is: " + id);
67    return jwt.sign({
68        _id: id
69    }, config.secrets.jwt, {
70        expiresIn: config.expireTime
71    });
72};

Sign in API call example

1curl --header "Content-Type: application/json" --request POST --data '{"username":"test_user_4","password":"12345"}' http://localhost:3000/auth/signin

, Output

{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1ZTY2NjQwODYzMGE0NDE3MThiMjNhMzgiLCJpYXQiOjE1ODQ2Mzc4NDIsImV4cCI6MTU4NDY1MjI0Mn0.MODWP86ebc8XOMjDGyuvNCWWoKnQhpZpl81ynFGExG8"}

Environment variables

Nodstarter starts searching first for the following environment variables if found them will use them if not will use the default. The default values for NODE_ENV is development, NODE_PORT is 3000 and JWT is Gambell You can choose the environment for the NODE_ENV variable from one of the following profiles (development, production, testing)

1. NODE_ENV
2. NODE_PORT
3. JWT

Setup

1. Init with npm:

1$ npm init

2. Install:

1$ npm install nodstarter

3. Start:

1$ npm start

, or use in one-line command:

1$ npm init; npm install nodstarter; npm start

Before running

Please make sure that the MongoDB daemon is up and running

• Ubuntu

systemctl start mongodb

• Macos

brew services run mongodb-community

Demo

Running Tests (future plan)

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

1$ npm install && npm test

Future plans

1. Swagger file for the existing APIs
2. Add tests for the existing APIs
3. Ability to make nodstarter a command line to install models, controllers and routers, etc.

New Ideas

If you have new ideas about the project please describe what you want to do and changes using an issue.

Contributing

See CONTRIBUTING.md

License summary

See License

NPM statistics

Project based