/transitionell-app

This repo hosts the Transition ELL app

Primary LanguageJavaScript

alt text

About Demdi

Comming Soon

Installation

  • Run git clone https://github.com/transitionell/app.git to clone this repo to your computer
  • Run cd ./app/ to navigate to dir
  • Run npm install to install dependencies

Front End Development

  • The source code for the front end is located in the ./client/ directory
  • The entry point for the front end modules is ./client/maint.ts
  • Be sure to first review the Angular documentation then follow the instructions below to start developing features for the front end client.

Launch dev server

  • Run ng serve for a dev server.
  • Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

  • Run ng generate component component-name to generate a new component.
  • You can also use ng generate directive|pipe|service|class|module.

Running unit tests

  • Run ng test to execute the unit tests via Karma.

Backend Development

  • The source code for the backend is located in the ./server/ directory
  • There are 2 entry points for the backend modules. ./server.js defines the Express.js server while ./server/routes/api.js defines the API routes
  • Be sure to first review the Express.js documentation then follow the instructions below to start developing features for the backend API.

Launch dev server

  • Run npm run serve for a dev server.
  • Navigate to http://localhost:3000/.

Build source code

  • Run npm run build:watch to build the project.
  • The code will automatically rebuild if you change any of the source files.
  • The build artifacts will be stored in the dist/ directory. Use the -prod flag for a production build.

Running 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 ng serve or npm run serve.

Source code managment

  • Be sure to read this article which presents A successful Git branching model
  • Please follow this model to help us straddle the line between flexibility & stability

Further help

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