Code Monkey home page Code Monkey logo

crankbit-backend's Introduction

AllGood Backend

Description

This is a Node.js application using Express.js. It features a RESTful API and is written in TypeScript. Key features include user authentication with JWTs, MongoDB with Mongoose for data storage, and email services using Nodemailer.

The application follows common security best practices, using packages like Helmet for setting HTTP headers, express-rate-limit for rate limiting, and bcrypt for password hashing. API documentation is handled with Swagger.

Prerequisites

Ensure you have Node.js version 18.0.0 or later.

Installation

Use the package manager npm to install the dependencies.

npm install

Usage

To run the app in development mode, use one of the following commands:

npm run dev
npm run start

To run the app in production mode with Node.js, use:

npm run start:node

To run the app in production mode with PM2, use:

npm run start:pm2

To build the application for production, use:

npm run build

Testing

To run tests, use:

npm run test

Linting

The project uses ESLint and Prettier for code formatting and consistency. You can manually lint the code using the following command:

npm run lint

Built With

crankbit-backend's People

Contributors

hangzh521 avatar lh-song avatar qiming-liu avatar jeremyhuang035 avatar zqwang39 avatar smarthulala 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.