Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrdav30/meancore
MEANcore - Open Source MEAN stack Boiler Plate
https://github.com/mrdav30/meancore
ag-grid angular bootstrap5 es6 expressjs javascript mean mongodb mongoose nodejs passport puppeteer typescript
Last synced: 9 days ago
JSON representation
MEANcore - Open Source MEAN stack Boiler Plate
- Host: GitHub
- URL: https://github.com/mrdav30/meancore
- Owner: mrdav30
- License: mit
- Created: 2019-02-18T21:56:36.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-27T04:26:33.000Z (8 months ago)
- Last Synced: 2024-03-27T05:32:52.010Z (8 months ago)
- Topics: ag-grid, angular, bootstrap5, es6, expressjs, javascript, mean, mongodb, mongoose, nodejs, passport, puppeteer, typescript
- Language: JavaScript
- Homepage:
- Size: 3.58 MB
- Stars: 14
- Watchers: 2
- Forks: 3
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.MD
- License: LICENSE.MD
Awesome Lists containing this project
README
[ MEANcore](https://github.com/mrdav30/MEANcore)
[](https://gitter.im/MEANcore/community)
[](https://david-dm.org/mrdav30/MEANcore)
[](https://david-dm.org/mrdav30/MEANcore?type=dev)
[](https://snyk.io/test/github/mrdav30/MEANcore?targetFile=package.json)
# MEAN Stack Starter Kit
MEANcore is an open-source boilerplate solution based on the MEAN stack and provides a solid starting point for [MongoDB](http://www.mongodb.org/), [Node.js](http://www.nodejs.org/), [Express](http://expressjs.com/), and [Angular](https://angular.io/) based applications. This project includes modern tools and workflow based on [angular-cli](https://github.com/angular/angular-cli), best practices from the community, a scalable base template and a good learning base.
### Benefits
- Quickstart a project in seconds and focus on features, not on frameworks or tools
- Industrial-grade tools, ready for usage in a continuous integration environment and DevOps
- Scalable architecture with base app template including example components, services and tests
- Module based development for both client and server
## Before You Begin
Before you begin, it's recommend you read about the basic building blocks that assemble a MEAN stack application:
* MongoDB - Go through [MongoDB Official Website](https://www.mongodb.com/) and proceed to their [Official Manual](http://docs.mongodb.org/manual/), which should help you understand NoSQL and MongoDB better.
* Express - The best way to understand express is through its [Official Website](http://expressjs.com/), which has a [Getting Started](http://expressjs.com/starter/installing.html) guide, as well as an [ExpressJS](http://expressjs.com/en/guide/routing.html) guide for general express topics. You can also go through this [StackOverflow Thread](http://stackoverflow.com/questions/8144214/learning-express-for-node-js) for more resources.
* Angular - Angular's [Official Website](https://angular.io/) is a great starting point.
* Node.js - Start by going through [Node.js Official Website](http://nodejs.org/) and this [StackOverflow Thread](http://stackoverflow.com/questions/2353818/how-do-i-get-started-with-node-js), which should get you going with the Node.js platform in no time.
Checkout our blog [Techievor](https://techievor.com) built on meancore for a full rundown on how to setup the MEAN stack with MEANcore:
* [Windows](https://techievor.com/blog/post/2019/02/28/how-to-install-the-mean-stack-on-windows)
* [CentOS](https://techievor.com/blog/post/2019/03/03/how-to-install-the-mean-stack-on-centos)
## Prerequisites
Make sure you have installed all of the following prerequisites on your development machine:
* Git - [Download & Install Git](https://git-scm.com/downloads). OSX and Linux machines typically have this already installed.
* Node.js - [Download & Install Node.js](https://nodejs.org/en/download/) and the npm package manager. If you encounter any problems, you can also use this [GitHub Gist](https://gist.github.com/isaacs/579814) to install Node.js. This version of MEANcore requires at minimum version >=14.0.0 of Node.js, v14.15.0 being the recommended.
* MongoDB - [Download & Install MongoDB](http://www.mongodb.org/downloads), and make sure it's running on the default port (27017). This version of MEANcore requires at minimum version >=4.2, v4.2.15 being the recommended.
# Getting Started
1. Go to project folder and create a .env file to setup your environment
```
NODE_ENV='development'
PRODUCTION=
HTTP_PROXY=
MONGO_SEED_LOG_RESULTS=true
GOOGLE_ANALYTICS_ID=''
GOOGLE_CLIENT_EMAIL=''
GOOGLE_PRIVATE_KEY=""
GOOGLE_VIEW_ID=
RECAPTCHA_SECRET_KEY=''
RECAPTCHA_SITE_KEY=''
MAILER_FROM='[email protected]'
MAILER_SERVICE_PROVIDER=
MAILER_HOST='smtp.ethereal.email'
MAILER_PORT=587
MAILER_USER='username'
MAILER_SECRET='pass'
MAILER_TEST=true
```
2. Setup link-package:
```bash
npm run init
```
This command will setup git hooks and preemptively bundle all package.json files located under the modules directory.
3. Next install dependencies:
```bash
npm install
```
4. Run the MongoDB Seed (Optional)
To have the default menu feature(s), role(s), and/or user account(s) at runtime:
```bash
npm run seed
```
This will try to seed the features, roles, and users based on the defined NODE_ENV in your env config. You have to copy the user passwords from the console and store it somewhere safe.
5. Running with TLS (Optional)
The application will start by default with the secuire configuration (SSL mode) turned off and listen on port 3000. To run your application in a secure manner, you'll need to use OpenSSL and generate a set of self-signed certificates. Unix-based users can use the following command:
```bash
npm run generate-ssl-certs
```
Windows users can follow the instructions found [here](https://support.citrix.com/article/CTX128656). After you've generated the key and certificate, ensure they are placed in the config/sslcerts folder.
6. Then launch development server, and open `localhost:4200` in your browser:
```bash
npm run start:dev
```
# Running in Production
To run MEANcore with production environment settings, you must set the following env variables:
```
NODE_ENV='production'
PRODUCTION=true
```
To enable/disable SSL mode in a production environment, set the HOST_SECURE variable in your env config.
Explore config/env/production.js for additional production environment configuration options.
# Project Structure
```
config/ configuration for express
dist/ compiled bundled client version
modules/** contains various modules that can be bundled together
|- client/ project source code for client
| |- app/ app components
| | |- app.component.* app root component (shell)
| | |- app.module.ts app root module definition
| | |- app-routing.module.ts app routes
| |- assets/ app assets (images, fonts, sounds...)
| |- environments/ values for various build environments
| | features/ additional modules and components
| |- theme/ app global scss variables and theme
| |- index.html html entry point
| |- main.scss global style entry point
| |- main.ts app entry point
| |- polyfills.ts polyfills needed by Angular
| +- test.ts unit tests entry point
|- e2e/ end-to-end tests
|- server/ project source code for server
project/ bundled client modules
shared_modules/ custom modules that are shared between the client and server
tools/ scripts for configuration and managing the application
|- bundle-modules.js bundles all module's client folder under project for ng build
|- bundle-packages.js bundles all module's packages into a single file in project root
|- generate-sitemap.js generates a sitemap.xml with all routes in project
|- generate-ssl-certs.sh generate self-signed certs for dev testing
|- init-core.js creates npm & git env vars for git hooks
|- link-packages.js replaces npm install/uninstall to keep all module packages in sync
|- seed-db.js seeds the db with default configuration based on config
|- set-env.ts run to configure environment configuration based on process.env
|- unbundle-packages.js reverse of bundle-packages
reports/ test and coverage reports
.env process.env variable configuration
proxy.conf.js backend proxy configuration
server.js script to launch express
```
# Main Tasks
Task automation is based on [NPM scripts](https://docs.npmjs.com/misc/scripts).
Tasks | Description
------------------------------|---------------------------------------------------------------------------------------
npm run init | Creates npm & git environment variables for git hooks used for link-packages
npm run bundle:packages | Bundles all packages under modules directory into single file used by root
npm run unbundle:packages | Reverses bundle:packages
npm run link:install | Replaces npm install; used to keep linked module packages in sync
npm run link:uninstall | Replaces npm uninstall; used to keep linked module packages in sync
npm run bundle:modules | Bundles all module's client folder into project directory for ng build
npm run watch:dev | Watches each module client directory for changes and rebundles into project folder for ng to pick up
npm run build:dev | Lint code and build app for development in `dist/` folder
npm run build:prod | Lint code and build app for production in `dist/` folder
npm run client:dev | Run development ng server on `http://localhost:4200/` only
npm run server:dev | Run development express server only on `http://localhost:3000/`
npm run server:prod | Run production express server only
npm run start:dev | Builds client and runs development ng server on `http://localhost:4200/` using proxy config for express endpoints to `http://localhost:3000/`
npm run start:prod | Builds client for prod and runs production express server
npm run test:client | Lint code and run unit tests once for continuous integration
npm run lint:client | Lint client code
npm run lint:server | Lint server code
npm run e2e | Run e2e tests using [Protractor](http://www.protractortest.org)
npm run generate-ssl-certs | Generates self-signed certificates on Unix-based systems using OpenSSL
npm run seed | Seeds the database with defaults based on defined configuration
## Link Packages
The follow parameters are used with link:install & link:uninstall
```
parms:
|--pkg={name of npm package}
|--type={type of dependency: blank or dependencies; dev or devDependencies}
|--mod={target mod; can leave blank for core}
```
## Development Server
Run `npm run start:dev` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change
any of the source files.
You should not use `ng serve` directly, as it does not use the backend express configuration.
## Code Scaffolding
Run `npm run generate -- component ` to generate a new component. You can also use
`npm run generate -- directive|pipe|service|class|module`.
If you have installed [angular-cli](https://github.com/angular/angular-cli) globally with `npm install -g @angular/cli`,
you can also use the command `ng generate` directly.
## Running Unit Tests
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
## Running End-to-End Tests
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
## Further Help
Tasks are mostly based on the `angular-cli` tool. Use `ng help` to get more help or go check out the
[Angular-CLI README](https://github.com/angular/angular-cli).
# What's In The Box
The app template is based on [HTML5](http://whatwg.org/html), [TypeScript](http://www.typescriptlang.org) and
[Sass](http://sass-lang.com).
#### Tools
Development, build and quality processes are based on [angular-cli](https://github.com/angular/angular-cli) and
[NPM scripts](https://docs.npmjs.com/misc/scripts), which includes:
- Optimized build and bundling process with [Webpack](https://webpack.github.io)
- Cross-browser CSS with [autoprefixer](https://github.com/postcss/autoprefixer) and
[browserslist](https://github.com/ai/browserslist)
- Asset revisioning for [better cache management](https://webpack.github.io/docs/long-term-caching.html)
- Server-side rendering for web-crawlers using [Puppeteer](https://github.com/GoogleChrome/puppeteer)
- Unit tests using [Jasmine](http://jasmine.github.io) and [Karma](https://karma-runner.github.io)
- End-to-end tests using [Protractor](https://github.com/angular/protractor)
- Static code analysis: [ESLint](https://github.com/eslint/eslint), [Angular-ESLint](https://github.com/angular-eslint/angular-eslint), [Stylelint](http://stylelint.io) and [HTMLHint](http://htmlhint.com/)
#### Libraries
- [Mongoose.js](https://mongoosejs.com/)
- [Express.js](https://expressjs.com/)
- [Angular](https://angular.io)
- [Node.js](https://nodejs.org/en/)
- [Ag-Grid](https://www.ag-grid.com/)
- [Font Awesome](http://fontawesome.io)
- [NgBootstrap](https://ng-bootstrap.github.io/#/home)
- [Bootstrap](https://getbootstrap.com/docs/5.0/getting-started/introduction/)
- [RxJS](http://reactivex.io/rxjs)
- [Moment.js](https://momentjs.com/)
- [Lodash](https://lodash.com)
- [Async](https://caolan.github.io/async/)
- [Passport.js](http://www.passportjs.org/)
- [Puppeteer](https://github.com/GoogleChrome/puppeteer)
- [Jimp](https://github.com/oliver-moran/jimp)
- [PngQuant](https://pngquant.org/)
## Contributing
Pull requests are welcome from the community! Just be sure to read the [contributing](https://github.com/mrdav30/MEANcore/blob/master/CONTRIBUTING.MD) doc to get started.
## Credits
Special thanks to the [MEAN.JS](https://github.com/meanjs/mean) team for the hard work they put into their project. I used their base for many projects over the years and learned a lot from what they accomplished.
# License
[License](https://github.com/mrdav30/MEANcore/blob/master/LICENSE.MD)