vannya-mern-app

2.0.6 • Public • Published

vannya-mern-app npm version Build Status

MERN app generator by Van Tabbert.
NPM link

My personal generator for quick CRUD applications.

Lots of the format is pulled from courses I have taken and merged together. This generator does take a bit to load, but be patient and it could save you a bunch of setup time.

If you'd like to use, please read all of the instructions before starting.

Requires npm 5.2+. Make sure your node and npm are up to date!


Data to collect before install

Please make sure that you have the following data for creation of the app:

  1. Google+ API OAuth Client ID and Secret ID.
  2. MongoDB Atlas database created with database user added. You'll need the URI code with your user and password inserted into it. This will work with other Mongo DBs as long as you provide the URI.
  3. Heroku for deployment. You'll need to add the config variables in your app at heroku.com.

Installation

Run using npx vannya-mern-app and answering the questions for setup.
Setup can take a while, especially at the Create-React-App step. Go get a drink and c'mon back!

After install navigate to the new directory (your app name) and npm start!
If you failed to provide the keys asked for during installation, you will need to update dev.js with the information before the application will run.


Included features

Front End:

  • Create-React-App V2
  • Redux
  • Google OAuth
  • React Router V4
  • Typescript integration
  • Support for CSS Modules and Sass (for Sass, install node-sass package)

Backend:

  • Express
  • Mongo/Mongoose
  • Passport
  • Google Auth
  • Dev and Prod keys setup
  • Cookie Session

Reporting issues

  • Look for any related issues.
  • If you find an issue that seems related, please comment there instead of creating a new one.
  • If you find no related issue, create a new one.
  • Include all details you can ( operative system, environment, interpreter version, etc.. ).
  • Include the error log.
  • Remember to check the discussion and update if there are changes.

Contributing

  • Fork the repository
  • Create your feature branch
  • Commit your changes and push the branch
  • Submit a pull request

Package Sidebar

Install

npm i vannya-mern-app

Weekly Downloads

0

Version

2.0.6

License

MIT

Unpacked Size

25.8 kB

Total Files

29

Last publish

Collaborators

  • vannya