Skip to content

This is a Express + MongoDB + Docker + Jest + Vue starter Template - Coyotiv - School of Software Engineering

License

Notifications You must be signed in to change notification settings

coyotiv-sose/template-express-mongo-docker-jest-vue

Repository files navigation

Coyotiv - School of Software Engineering

Express + MongoDB + Docker + Jest + Vue starter Template

 


 

License: MIT

 

Open in Gitpod  

Now you can directly work in your browser!
 

Getting started

 

NODE - EXPRESS - MONGODB - DOCKER - JEST - VUE

 

Install dependencies in backend folder

cd backend
npm install

 

Install dependencies in frontend folder

cd frontend
npm install

 

Start development server:

  • Backend

    • with Node.js:

      cd backend
      npm start
    • with nodemon:

      cd backend
      npm run dev
    • with Docker:

      docker-compose up --build
  • Frontend

    • Compiles and hot-reloads for development

      cd frontend
      npm run serve
      
    • Compiles and minifies for production

      cd frontend
      npm run build
      
    • Lints and fixes files

      cd frontend
      npm run lint
      

Run the backend tests with Jest:

  • without coverage:

    cd backend
    npm test
  • with coverage:

    cd backend
    npm test-coverage

 

Working with env variables and .env files

 

Note:

  • We have automated for you the following step to make the copy from the .env.example:
    > sh > cp .env.example .env >
  • Please before starting the server update the .env file values accordingly if necessary
     

 

To add new env variables:

  • Add them directly in the .env file inside of each directory
  • Add a copy of this env variables with an example value (not the real one) in the .env.example file  

To modify a env variables:

  • Modify them directly in the .env file

 

PLANTUML

 

Note:
> - There is a class.puml example file located in the architecture folder.
 

 

To start working *.puml files:

  • You can continue by editing the class.puml file
  • Add additional *.puml files on that folder too.
     

If you what to visualize a preview of the class.puml file or another *.puml file on the project, please select the file and on your keyboard press the following keys:

 

  • MacOS: Option + D

  • Linux/Windows: Alt + D

 

The above commands will automatically open a window that will show you live any updates that you make on the file.

 

** Note:

  • If you what to visualize a preview of the *.puml file locally without Gitpod, to avoid a render error, please go to the settings.json file under the .vscode folder and comment out the following:
"plantuml.server": "http://localhost:8080",
"plantuml.render": "PlantUMLServer",

 


 
Now that we are ready, let's have some coding fun!


 

MIT License

Copyright (c) 2022 Coyotiv

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

This is a Express + MongoDB + Docker + Jest + Vue starter Template - Coyotiv - School of Software Engineering

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published