https://github.com/izmjs/izmjs
Highly maintainable & modular NodeJS project architecture.
https://github.com/izmjs/izmjs
Last synced: 3 months ago
JSON representation
Highly maintainable & modular NodeJS project architecture.
- Host: GitHub
- URL: https://github.com/izmjs/izmjs
- Owner: izmjs
- License: mit
- Created: 2019-08-15T21:53:19.000Z (almost 6 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-23T23:54:52.000Z (over 2 years ago)
- Last Synced: 2025-03-28T03:51:11.437Z (3 months ago)
- Language: JavaScript
- Homepage: https://izmjs.netlify.app/
- Size: 5.23 MB
- Stars: 93
- Watchers: 7
- Forks: 8
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
## NodeJS, Express and MongoDB starter
[](https://open.vscode.dev/izmjs/izmjs)
[![npm version][npm-badge]][npm]
[![vulnerabilities][vulnerabilities-badge]][vulnerabilities]
[![PRs Welcome][prs-badge]][prs]
[![MIT License][license-badge]][license]
[](https://www.youtube.com/watch?v=BlMCotURwAk)
## Table of Content
- [Getting Started](#getting-started)
- [Useful Commands](#useful-commands)
- [VSCode helpers](#vscode-helpers)
- [Misc](#misc)
## Getting started
### Using `izm` CLI
```bash
npx izm
# Then follow the wizard
```
### Manual clone
```bash
git clone [email protected]:izmjs/izmjs.git new-project
cd new-project
npm i
echo "NODE_ENV=development" > .env/.common.env
cp .example.env .env/.development.env
```
Optional: Add `devtools` functional module:
```bash
git clone [email protected]:izmjs/devtools.git modules/devtools
npm i
```
Start the project
```bash
npm start
```
## Useful Commands
- `npm start` - starts a dev server with [nodemon](https://github.com/remy/nodemon)
- `npm test` - runs tests with `mocha`
- `npm run generate:module [name]` - generate a new module (Optionnally you can give the name in the command line, otherwise you will be prompted to choose a name.)
## VSCode helpers
### iam
This shortcut will put a definition of new IAM rules in the file.
### iam:route
Will generate a new route
### iam:method
Will generate the definition of a method.
### ctrl
Create new controller.
### module:model
Generate a new mongoose model.
## Misc
To skip loading a module, specify it in the env variable `SKIP_MODULES`
_Example_
```
SKIP_MODULES=modules/devtools,modules/data-browser
```
## Defining custom views
In order to define new paths of a specific template, use the file `config/lib/views.js(on)`.
_Example_
```json
(module.exports = {
"vendor/core/views/404": "views/{{req.i18n.language}}/404"
})
```
In the examples above, we are redefining how to render `404` pages depending on the language of the current user. Meaning, if the language is `en` for example, the server will look for a file named `views/en/404.server.view.swig`. If not found, the server will render the default file: `vendor/core/views/404`.
_Tip_: Use `req.rndr` to render a template without sending a response to the client.
## Auto depmloyment (Gitlab CI)
You need to define these environment variables in your repository:
- `PRODUCTION_URL`: [The production URL](https://docs.gitlab.com/ee/ci/environments.html#making-use-of-the-environment-url)
- `PRODUCTION_DEPLOY_SERVER`: List of production servers addresses or IP addresses. Should be separated by `,`.
- `PRODUCTION_DEPLOY_PATH`: Where to deploy project on production hosts.
- `PRODUCTION_SSH_PRIVATE_KEY`: The SSH key to use to connect to production servers.
- `STAGING_URL`: [The staging URL](https://docs.gitlab.com/ee/ci/environments.html#making-use-of-the-environment-url)
- `STAGING_DEPLOY_SERVER`: List of staging servers addresses or IP addresses. Should be separated by `,`.
- `STAGING_DEPLOY_PATH`: Where to deploy project on staging hosts.
- `STAGING_SSH_PRIVATE_KEY`: The SSH key to use to connect to staging servers.
## License
MIT © Mohamed IDRISSI
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
[prs]: http://makeapullrequest.com
[npm-badge]: https://badge.fury.io/js/func-loc.svg
[npm]: https://www.npmjs.com/package/func-loc
[vulnerabilities-badge]: https://snyk.io/test/github/midrissi/func-loc/badge.svg?targetFile=package.json
[vulnerabilities]: https://snyk.io/test/github/midrissi/func-loc?targetFile=package.json
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[license]: https://github.com/midrissi/func-loc/blob/master/LICENSE