Skip to content

SpartaHack/SpartaHack-Website2019

Repository files navigation

SpartaHackV

What is this?

This Repo holds the Angular front-end for SpartaHack V's website.

Frameworks

Before you devlop...

  1. Install NodeJS if you have not already
  2. Install Angular CLI version 6.0.7.
    • In a command prompt, run npm install -g @angular/cli
  3. Install your IDE of choice.
    • My Go-To for Angular Development is Visual Studio Code. It's free, integrates well with git, and handles TypeScript fairly well.
    • Extensions I use in VS Code:
      • TSLint: A linter for TypeScript, although it now displays all of its warning as errors so it's been disabled recently
      • Auto Import: A life-saver when you need to add a component from an npm package. It'll find it for you!
      • vscode-icons: Just makes things a bit nicer to look at
      • Angular v6 Snippets: Literally writes code for you! Creates Components, which can be a pain to get right see a list of all of the options available here

Development 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.

Development 'Best Practices'

  • Components are your best friend. They keep code organized, reusable, and easy to find.
  • Bootstrap is your friend that it can be fun to go to the bar with sometimes. Don't be afraid to write your own css!
    • One thing you NEED Bootstap for is its grid system. It's easy to use and can take care of scaling problems for you if used correctly! )

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Further help

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