Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stanleygomes/nodevader
An awesome Node.js boilerplate 🌑
https://github.com/stanleygomes/nodevader
boilerplate hacktoberfest javascript nodejs
Last synced: 2 months ago
JSON representation
An awesome Node.js boilerplate 🌑
- Host: GitHub
- URL: https://github.com/stanleygomes/nodevader
- Owner: stanleygomes
- License: mit
- Created: 2019-10-21T22:44:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T04:59:39.000Z (almost 2 years ago)
- Last Synced: 2023-03-05T08:33:15.027Z (almost 2 years ago)
- Topics: boilerplate, hacktoberfest, javascript, nodejs
- Language: JavaScript
- Homepage: https://bit.ly/nodevaderBoilerplate
- Size: 1.13 MB
- Stars: 17
- Watchers: 1
- Forks: 5
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Nodevader
[](https://www.codefactor.io/repository/github/stanleygomes/nodevader)
An awesome Node.js boilerplate. Come to the node side 🌑
The main goal of **Nodevader** is to set patterns to be easily implemented on Nodejs projects. We want to make easy to quick start a Nodejs ambient with the basic resources every project could have. Check out the patterns we defined this document bellow.
Icon by Filipe Carvalho
*******
Table of contents
0. [Requirements](#requirements)
1. [How to get Started](#startup)
2. [Gitflow recommendations](#gitflow)
3. [Patterns and libs](#patterns)
4. [Samples and tutorials of use](#tutorials)
5. [Project structure](#projetcstructure)
6. [Licence](#license)
*******
## :pencil: Requirements
This boilerplate supports Node.js from version v12.x
## :rocket: Startup
Step by step to get this up and running
### Clone repo and go to project folder
```
git clone https://github.com/stanleygomes/nodevader.git && cd nodevader
```
### Install dependencies
```sh
npm install
```
### Start server
Via express server
```sh
npm run dev
```
### Start enviroment
Copy enviroment variables template
```sh
cp .env.template .env
```
Via docker-compose (start database, run migrations and start server)
```sh
docker-compose up
```
To test it on the browser, simply go to: `http://localhost:3000/welcome`
## :trident: Git flow
To file a new a feature
- create a branch from `master` branch. Use the pattern: `feature/description`
- file a pull request on `master` branch
- since your PR is aproved, it will be merged to `master` branch
- in a moment in time we'll create a release, using the pattern: `release/vX.X.X`
## :heavy_check_mark: Patterns
These are some of patterns definitions to help us to keep a default arquitecture.
- Package manager: [npm](https://medium.com/@vincentnewkirk/npm-vs-yarn-2019-e88757b17038), sure
- Node version: [v12.x](https://nodejs.org/ca/blog/release/v12.14.1)
- Node Framework: [Express](https://expressjs.com) framework
- Node server: [Nodemon](https://www.npmjs.com/package/nodemon) and [PM2](https://pm2.keymetrics.io/)
- Linter: eslint [standard](https://standardjs.com) pattern
- Database: Use [knex](http://knexjs.org) query builder and some utils methods on utils/database.js (mysql and postgres support)
- Migrations: Run on a container described in docker-compose file: [boxfuse/flyway](https://hub.docker.com/r/boxfuse/flyway/dockerfile) image
- Template transpiler: [Mustache](https://mustache.github.io) templates
- i18n: take a look [here](https://www.npmjs.com/package/i18n)
- Date and time: [date-fns](https://date-fns.org)
- Test: [Mocha](https://mochajs.org) & [Chai](https://www.chaijs.com)
- Logs: use [Winston](https://www.npmjs.com/package/winston)
- Http Request: use [Axios](https://github.com/axios/axios)
- Authentication: [JWT](https://www.npmjs.com/package/jwt)
- SMTP email: Send emails using [Nodemailer](https://www.npmjs.com/package/nodemailer) and html templates with mustache
- Express: [Cors](https://www.npmjs.com/package/cors) enabled, [cookie](https://www.npmjs.com/package/cookie-parser) and [body](https://www.npmjs.com/package/body-parser) parser, [helmet](https://www.npmjs.com/package/helmet) headers
- Migrations: use [postgrator](https://www.npmjs.com/package/postgrator), running `npm run migrate`. Place your migrations on `src/migrations`
- Docker compose and dockerfile attached running migrations e starting database and nodejs
## :books: Tutorials
Some useful tutorials to improve nodevader's features:
- Main features: [check here](https://from-tatooine.web.app/nodevader-first-release/)
- Deploy to firebase functions: [check here](https://from-tatooine.web.app/deploy-nodejs-firebase)
## :open_file_folder: Project structure
Basic folder structure
- **src/config**: App config (some of these are inherited from .env file), constants, configuration and i18n
- **src/api**: Endpoints and business logic
- **src/static**: Images, styles, fonts and other files that can be served
- **src/middlewares**: Middlewares for routes
- **src/routes**: Routes, :]
- **src/templates**: mustache interpreted files
- **src/test**: Mocha and chai unity tests
- **src/utils**: Utilities and modules superior layer implementations
## :scroll: License
```
MIT license. Copyright (c) 2021 Stanley.
For more information, see the LICENSE file.
```