Skip to content

Create repo with the help of fast-mvp repo template

Notifications You must be signed in to change notification settings

luctst/fast-mvp-cli

Repository files navigation



fast-mvp-cli

Create your new mvp with the help of fast-mvp repo template

Build Status NPM version Package size Dependencies devDependencies Status code style: prettier Twitter


Why ?

Starting a project today is fastidious you must initiate repo, devtools, container, server etc...

This project tends to resolve this problem with one command you get:

  • Repo created with https://github.com/luctst/fast-mvp template.
  • API with (nodejs, mongodb, mongoose, express) running on port 9229.
  • Web app with (vuejs, scss, vue-router, vuex) running on port 8080.
  • Redis instance running on port 6379.
  • Docker container with docker-compose to isolate all your services.

Note - If your database is hosted with mongodb atlas you can run bdd.sh script who will create a dumb of your database in the mongodb container.

What you need

You must have on your computer:

  • Docker.
  • MacOs operating system.
  • vue-cli installed globally.
  • Nodejs >= 12.0.0.

Install 🐙

Globally

npm i -g fast-mvp-cli

npx

npx fast-mvp-cli

Required npm >= 5.2

Usage 💡

Run in your terminal app.

fast-mvp-cli

Once installed do not hesitate to read the README.md file then you can run in your new folder created docker-compose up -d that will create and start your containers.

Note If you want use the bdd.sh script, you must create at the root .env file with $DB_URL variable who contains the endpoint of your mongodb atlas database, then replace all <database> by your database name.

Contributing 🍰

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to this project!

Maintainers 👷

List of maintainers, replace all href, src attributes by your maintainers datas.

Tostee Lucas
Tostee Lucas

💻

License ⚖️

@MIT


About

Create repo with the help of fast-mvp repo template

Resources

Code of conduct

Stars

Watchers

Forks

Packages

No packages published