Skip to content

Commit

Permalink
Added initial cut of instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jawache committed Feb 9, 2017
1 parent 85d4f25 commit 7a0d986
Showing 1 changed file with 53 additions and 29 deletions.
82 changes: 53 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,55 @@
# Bookshelf

This project was generated with [angular-cli](https://github.com/angular/angular-cli) version 1.0.0-beta.26.

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

## Code scaffolding

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

## 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](https://karma-runner.github.io).

## Running end-to-end tests

Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
Before running the tests make sure you are serving the app via `ng serve`.

## Deploying to GitHub Pages

Run `ng github-pages:deploy` to deploy to GitHub Pages.

## Further help

To get more help on the `angular-cli` use `ng help` or go check out the [Angular-CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
- This is the final project for the [CodeCraft Angular Course](https://ng2.codecraft.tv/)
- In this project you will create an Angular CLI powered SPA, consuming the Google Books API, implementing search, pagination as well as saving favorite books to local storage.
- Before you start this project make sure you have either gone through the official
[CodeCraft Angular Course or Book](https://ng2.codecraft.tv/) - it's *FREE* - or are comfortable with the material and sections in that course already.

## Instructions

1. Fork this repository and clone it onto your computer.
2. Checkout the master branch and use that as the starting point.
3. Follow the instructions in [this video]() - this explains what I need you to create, where you are starting from and what the expectations are of the completed application.
4. If you feel confident you can go ahead and attempt to complete the project yourself with no further hints.
5. If you are stuck or want to validate your work as you go along then i've broken down the project into 8 steps with completed code, hints and code walkthroughs.

## Code Reviews

For *workshop participants only* you can also submit a pull request of your completed code for review and feedback.

Instructions on how to submit a pull request can be found in this [video](https://vimeo.com/200501735/ad26e323b1).

## Steps

Each step has:-

- A video which explains what to build for that step.
- A branch with the completed code for that step, which you can compare against your own attempt.
- A video walk-through of me completing that step, which you can watch if you are stuck or if you want to validate the work you've done before you move to the next step.

---

1. Services
- [Instructions & Walkthrough]()
- The `step-1` branch - is the completed code for step 1.
2. Routing
- [Instructions & Walkthrough]()
- The `step-2` branch - is the completed code for step 2.
3. Navigation
- [Instructions & Walkthrough]()
- The `step-3` branch - is the completed code for step 3.
4. Searching
- [Instructions & Walkthrough]()
- The `step-4` branch - is the completed code for step 4.
5. Pagination
- [Instructions & Walkthrough]()
- The `step-5` branch - is the completed code for step 5.
6. BookList
- [Instructions & Walkthrough]()
- The `step-6` branch - is the completed code for step 6.
7. Book
- [Instructions & Walkthrough]()
- The `step-7` branch - is the completed code for step 7.
8. Library
- [Instructions & Walkthrough]()
- The `step-8` branch - is the completed code for step 8.

0 comments on commit 7a0d986

Please sign in to comment.