Next Node Project

The absolute start-point of your next backend project

Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
  • Features
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License

About The Project

We all know that a project without a good structure is anything but scalable. It is hard to design your project thinking about how big it can become. This repo is an opinionated project structure for a Node.js API. It is built with Express.js, Mongoose and TypeScript but can easily be configured to match your developer taste.

Features

• Full TypeScript support
• Feature-first project structure
• Easy input validation with Joi.js
• jwt stateless auth boilerplate
• Maintainable aproach in endpoints structuring

Built With

• Node.js
• Express.js
• TypeScript
• Mongo DB
• Mongoose

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• Install Node.js

Installation

1. Clone the repo

git clone https://github.com/AlexandruRoman/next-node-project.git

2. Install NPM packages

npm install

3. Enter your Mongo connection string in src/mongo.ts

const url = 'YOUR CONNECTION STRING'

Usage

Running the app in dev mode:

npm start

Creating a production build of the app:

npm run build

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License.