Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/djizco/mern-boilerplate
A Full MERN Stack Boilerplate for Web Apps including a local authentication system. Uses React, Express.js, MongoDB, Redux, Passport.js, Webpack, Testing, and more.
https://github.com/djizco/mern-boilerplate
boilerplate bulma css eslint express jest mongodb mongoose nodejs passport ramda react redux webpack
Last synced: about 4 hours ago
JSON representation
A Full MERN Stack Boilerplate for Web Apps including a local authentication system. Uses React, Express.js, MongoDB, Redux, Passport.js, Webpack, Testing, and more.
- Host: GitHub
- URL: https://github.com/djizco/mern-boilerplate
- Owner: djizco
- License: mit
- Created: 2018-04-29T05:36:49.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-11-11T07:03:09.000Z (11 months ago)
- Last Synced: 2024-09-19T23:01:59.308Z (5 days ago)
- Topics: boilerplate, bulma, css, eslint, express, jest, mongodb, mongoose, nodejs, passport, ramda, react, redux, webpack
- Language: JavaScript
- Homepage:
- Size: 329 KB
- Stars: 266
- Watchers: 6
- Forks: 93
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MERN Boilerplate
MongoDB Express.js React.js Node.js
A Full MERN Stack Boilerplate for Web Apps. Includes a local authentication system using passport. User is given a simple profile with Full Name and Profile Picture. User is also able to reset password and username case.
NEW: For those of you who wish to separate the client and server into separate projects, I have created two repos that do just that! Check out [MERN Client](https://github.com/djizco/mern-client) and [MERN Server](https://github.com/djizco/mern-server).
## Requirements
* Operating System: MacOS or Linux
* [Node.js](https://nodejs.org/) (I recommend installing with [NVM](https://github.com/nvm-sh/nvm))
* [Homebrew](https://brew.sh) (to install MongoDB)
## Quick Start
#### Setup
```bash
npm install
# Install MongoDB
brew tap mongodb/brew
brew install mongodb-community
```
Start the database
```bash
brew services start mongodb-community
```
#### for Development
Start the client
```bash
npm run start:client
```
Start the server
```bash
npm run start:server
```
Or run client and server together
```bash
npm start
```
#### for Production
```bash
npm run build
npm start:server
```
#### Other Commands
```bash
npm start
npm test
npm run lint
npm run lint:fix
npm run test:verbose
npm run test:coverage
npm run test:watch-client
npm run test:watch-server
```
## Setup Instructions
Note: This is now a github template project. This makes copying the contents of the project
into a new repo very simple.
To setup your own project, you will need to copy the contents of this project into a new repo.
You will need to update the content in these files to names of your project and yourself:
* package.json: name, version, description, repository, author, bugs, homepage
* LICENSE: (update to your preferred license)
* client/index.html: description and title
* this README.md
This is also a good time to go through the included libraries to add or remove features that you want.
After this you can commit the files into a new repository and push up to your github.
You can now start updating files in your client to begin working on your own project!
## Features
* Webpack conveniently bundles your code for you.
* Babel lets you use ES6/7 features.
* CSS pre-processor setup for LESS and SASS lets you keep your styles clean and organized.
* ESLint helps you maintain a high level of code quality.
* Jest gives you a robust testing framework to make sure your code works.
## Code Structure
```
- client
- api
- assets
- images
- icons
- components
- pages
- environment
- hooks
- store
- actions
- reducers
- thunks
- tests
- styles
- utils
- server
- config
- database
- routes
- scripts
```
## Technologies
[React](https://facebook.github.io/react/) - View Library
[Redux](http://redux.js.org/) - State Manager
[Webpack](https://webpack.github.io/) - Module Bundler
[Express](http://expressjs.com/) - Node Application Framework
[MongoDB](https://www.mongodb.com/) - Document Database
[Mongoose](http://mongoosejs.com/) - MongoDB Framework
[Passport](http://www.passportjs.org/) - Authentication Framework
[React Notifications Component](https://teodosii.github.io/react-notifications-component/) - Notification System
[Material-UI](http://material-ui.com/) - React Component Library
[Bulma](http://bulma.io/) - CSS Framework
[React Bulma Companion](https://github.com/djizco/react-bulma-companion) - Bulma Component Library
[FontAwesome](http://fontawesome.io/) - Icons
[Ramda](http://ramdajs.com/) - Functional Library
[date-fns](https://date-fns.org/) - Date Functions Library
[SuperAgent](https://github.com/visionmedia/superagent) - HTTP Request Library
[ESLint](http://eslint.org/) - Code Linter
[Jest](https://jestjs.io/) - Testing Framework