zerotohero-dev/nodejs-project-structure

A sample file and folder structure for a Node.JS project.

 _____       _          __ _____
|   | |___ _| |___   __|  |   __|
| | | | . | . | -_|_|  |  |__   |
|_|___|___|___|___|_|_____|_____|
 _____           _         _
|  _  |___ ___  |_|___ ___| |_
|   __|  _| . | | | -_|  _|  _|
|__|  |_| |___|_| |___|___|_|
 _____ _      |___|    _
|   __| |_ ___ _ _ ___| |_ _ _ ___ ___
|__   |  _|  _| | |  _|  _| | |  _| -_|
|_____|_| |_| |___|___|_| |___|_| |___|

Summary

A sample folder structure for a Node.JS project.

About the “Node.JS Project Structure” Project Structure

Node.JS projects do not have a hard-and-fast folder structure.

This repository is one of the many ways a typical Node.JS project can be structured.

Wanna Help?

Any help is more than appreciated.

If you want to contribute to the source code, fork this repository and create a pull request.

In lieu of a formal style guide, take care to maintain the existing coding style.

Also, don’t forget to add unit tests for any new or changed functionality.

If you want to report a bug; or share a comment or suggestion, file an issue.

I’ve Found a Bug; I Have an Idea

For bug reports and suggestions, please file an issue.

Contact Information

• Project Owner: Volkan Özçelik
• Project Website: bytesized.tv

License

MIT-licensed. — See the license file for details.

Code of Conduct

We, as the community behind this project, are committed to making participation in this project a harassment-free experience for everyone, regardless of the level of expertise, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion or nationality.

See the code of conduct for more details.

A ByteSized.TV Project

This repository is a part of the Byte-Sized JavaScript VideoCasts.

It is a compilation of short (around ten minutes) screencasts about JavaScript and related technologies.

Learn, explore, and have fun!

nodejs-project-structure's Issues

What about Front?

public is for front-end, but what if front-end is compiled and built with gulp/grubt/webpack ect?
Seems, it's frequent situation.

What is the most accepted solution?

Divide to src and dist in public?
Or create src in root and dist in public?
Or not src but assets like in many frameworks...