Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade to 2.17 #30

Closed
wants to merge 6 commits into from
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
README
snewcomer committed Dec 23, 2017
commit 0319f648bd0dc39dee0d9aac6b1c81a5a38391a4
89 changes: 71 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,71 @@
# realworld-ember
# ![RealWorld Ember Example App](logo-ember.png)
> ### Ember.js codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld-example-apps) spec and API.
This README outlines the details of collaborating on this Ember application.
A short introduction of this app could easily go here.

### [Demo](https://ember.realworld.io/)    [RealWorld](https://github.com/gothinkster/realworld)

[![Build Status](https://travis-ci.org/gothinkster/ember-realworld.svg?branch=master)](https://travis-ci.org/gothinkster/ember-realworld)

This codebase was created to demonstrate a fully fledged fullstack application built with **Ember** including CRUD operations, authentication, routing, pagination, and more.

We've gone to great lengths to adhere to the **Ember** community styleguides & best practices.

For more information on how to this works with other frontends/backends, head over to the [RealWorld](https://github.com/gothinkster/realworld) repo.

## Prerequisites

You will need the following things properly installed on your computer.

* [Git](https://git-scm.com/)
* [Node.js](https://nodejs.org/)
* [Yarn](https://yarnpkg.com/)
* [Ember CLI](https://ember-cli.com/)
* [Google Chrome](https://google.com/chrome/)
* [Git](http://git-scm.com/)
* [Node.js](http://nodejs.org/) (with NPM)
* [Bower](http://bower.io/)
* [Ember CLI](http://www.ember-cli.com/)
* [PhantomJS](http://phantomjs.org/)

# How it works

> Describe the general architecture of your app here
# Getting started

## Installation

* `git clone <repository-url>` this repository
* `cd realworld-ember`
* `yarn install`
* `git clone <https://github.com/gothinkster/ember-realworld.git>` this repository
* change into the new directory
* `yarn`

## Running / Development

* `ember serve`
* `ember serve` or `yarn start`
* Visit your app at [http://localhost:4200](http://localhost:4200).
* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).

When running in development mode the application will use mock data, if you would like
to run against the real conduit API you can do the following:

* `ember serve --proxy https://conduit.productionready.io` or `yarn start:dev`

### Code Generators

Make use of the many generators for code, try `ember help generate` for more details

### Linting

This project uses a combination of [ESLint][eslint] and [Prettier][prettier] to maintain uniform style for our JavaScript code.

To run verification of the code, but not fix anything automatically, you can run

* `yarn lint`

However, thanks to the power of the tools we use, many problems can be fixed automatically. That can be done by running

* `yarn lint:fix`

Which will detect which problems can be fixed automatically and write the correct version back to the files in question.

### Running Tests

* `ember test`
* `ember test --server`
* `ember test` or `yarn test`
* `ember test --serve` or `yarn test:s`

### Building

@@ -41,12 +74,32 @@ Make use of the many generators for code, try `ember help generate` for more det

### Deploying

Specify what it takes to deploy your app.
TODO

## Further Reading / Useful Links

* [ember.js](https://emberjs.com/)
* [ember-cli](https://ember-cli.com/)
* [ember.js](http://emberjs.com/)
* [ember-cli](http://www.ember-cli.com/)
* Development Browser Extensions
* [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi)
* [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)

[eslint]: http://eslint.org/
[prettier]: https://github.com/prettier/prettier


# Who made this?

RealWorld Ember has a core project team composed of:

#### [Alon Bukai](https://alonbukai.com)

<img align="left" width="40" height="40" src="https://avatars1.githubusercontent.com/u/452199?v=3&s=100">

Alon is a Full Stack Software Engineer who has been coding since he was 13. Today he is a Software Engineer working in Ember.js on the frontend and C# .Net on the backend. At night he is studying for his Software Engineering Degree. In the middle of the night he is working on this repo.

#### [Alex LaFroscia](http://alexlafroscia.com)

<img align="left" width="40" height="40" src="https://avatars0.githubusercontent.com/u/1645881?v=3&s=100">

TODO
105 changes: 0 additions & 105 deletions readme.md

This file was deleted.