/mern-starter

An easy to use, mern template to kickstart developing apps

Primary LanguageJavaScriptMIT LicenseMIT

MERN Starter Template


An easy to use, mern template to kickstart developing apps


Hosted on Heruko

https://mern-starter.herokuapp.com/

Structure

    .
    ├── client                        # client react app
        ├── dist                      # client build folder
        ├──  src
            ├──  components           # react components
            ├──  images               # image assets
            ├──  index.css            # base css
            ├──  index.html           # base html
            ├──  index.jsx            # base react component
        ├──.babelrc                   # babel config
        ├──.package.json
        ├──.webpack.config.babel.js   # webpack config written in es6
    ├── server                        # server express app
        ├── build                     # server build folder
        ├──  src
            ├──  bin
                ├──  www.js           # sever entry point
            ├──  routes               # routes folder
                ├──  index.js
            ├──  database.js          # database config
            ├──  server.js            # server config
        ├──.babelrc                   # babel confi
        ├──  .env                     # env variables
        ├──.package.json
    ├── .eslintrc.json                # es linting config
    ├── .prettierrc
    ├── .travis.yml                  # travis CI
    ├── package.json
    ├── LICENSE
    └── README.md

Development setup

Fork it and clone as local repository.

$ cd mern-starter
$ npm install
$ npm run client-install
$ npm run server-install

Create a .env file in server folder as follows:

DATABASE=your_database_uri

Run app locally:

$ npm run dev

Run only client react app locally:

$ cd client
$ npm run start

Run only server express app locally:

$ cd server
$ npm run dev-start

Contributing

  1. Read the CODE OF CONDUCT
  2. Fork the repo
  3. Create your feature branch (git checkout -b feature/fooBar)
  4. Commit your changes (git commit -am 'Add some fooBar')
  5. Push to the branch (git push origin feature/fooBar)
  6. Create a new Pull Request