Skip to content

Latest commit

 

History

History
82 lines (63 loc) · 4.2 KB

README.md

File metadata and controls

82 lines (63 loc) · 4.2 KB

Angular Full Stack Dependencies Donate MIT license

The frontend is generated with Angular CLI. The backend is made from scratch. Whole stack in TypeScript.

This project uses the MEAN stack:

Other tools and technologies used:

Prerequisites

  1. Install Node.js and MongoDB
  2. Install Angular CLI: npm i -g @angular/cli
  3. From project root folder install all the dependencies: npm i

Run

Development mode

npm run dev: concurrently execute MongoDB, Angular build, TypeScript compiler and Express server.

A window will automatically open at localhost:4200. Angular and Express files are being watched. Any change automatically creates a new bundle, restart Express server and reload your browser.

Production mode

npm run prod: run the project with a production bundle and AOT compilation listening at localhost:3000

Deploy (Heroku)

  1. Go to Heroku and create a new app (eg: your-app-name)
  2. Install Heroku CLI
  3. heroku login
  4. mkdir your-app-name && cd your-app-name
  5. git init
  6. heroku git:remote -a your-app-name
  7. Download this repo and copy all files into your-app-name folder
  8. npm i
  9. Edit package.json as following:
    • add this line to scripts: "postinstall": "tsc -p server && ng build -aot -prod"
    • move the following packages from devDependencies to dependencies: @angular/cli, @angular/compiler-cli, @types/jasmine, @types/node, chai, chai-http and typescript.
  10. Edit .env and replace the MongoDB URI with a real remote MongoDB server. You can create a MongoDB server with Heroku or mLab.
  11. git add .
  12. git commit -m "Going to Heroku"
  13. git push heroku master
  14. heroku open and a window will open with your app online

Preview

Preview

Please open an issue if

  • you have any suggestion to improve this project
  • you noticed any problem or error

To do

  • More tests

Running frontend unit tests

Run ng test to execute the unit tests via Karma.

Running frontend end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor. Before running the tests make sure you are serving the app via npm start.

Running backend tests

Run mongod to run an instance of MongoDB, then run npm run testbe to execute the backend tests via Mocha.

Running TSLint

Run ng lint (frontend) and npm run lintbe (backend) to execute the linter via TSLint.

Wiki

To get more help about this project, visit the official wiki.

Further help

To get more help on the angular-cli use ng --help or go check out the Angular-CLI README.

Author