|
1 | | -# Firefox Accounts Content Server |
2 | | - |
3 | | -[](https://travis-ci.org/mozilla/fxa-content-server) |
4 | | -[](https://circleci.com/gh/mozilla/fxa-content-server) |
5 | | -[](https://coveralls.io/r/mozilla/fxa-content-server) |
6 | | - |
7 | | -Static server that hosts [Firefox Account sign up](https://accounts.firefox.com), sign in, email verification, etc. flows. |
8 | | - |
9 | | -* [Quick Start](#quick-start) |
10 | | -* [Development Notes](#development-notes) |
11 | | - * [Changes to Stylesheets](#changes-to-stylesheets) |
12 | | - * [Changes to Scripts and Templates](#changes-to-scripts-and-templates) |
13 | | -* [Testing](#testing) |
14 | | - * [Prerequisites](#prerequisites) |
15 | | - * [Setup](#setup) |
16 | | -* [Grunt Commands](#grunt-commands) |
17 | | -* [Servers](#servers) |
18 | | -* [License](#license) |
19 | | - |
20 | | ---- |
21 | | - |
22 | | -## Quick Start |
23 | | - |
24 | | -Clone the repository, make sure you have [required prerequisites](https://github.com/mozilla/fxa-local-dev#dependencies) installed. |
25 | | -Run `npm install` and `npm run start-remote`. |
26 | | -This will start a local fxa-content-server on [http://127.0.0.1:3030](http://127.0.0.1:3030) that works with remote Firefox Accounts servers. |
27 | | - |
28 | | -If you want to install all Firefox Accounts servers locally follow the instructions on: |
29 | | -[fxa-local-dev](https://github.com/mozilla/fxa-local-dev) to get a full development setup running. |
30 | | -Please note that fxa-local-dev is the preferred way of contributing to Firefox Accounts. |
31 | | - |
32 | | ---- |
33 | | - |
34 | | -## Development Notes |
35 | | - |
36 | | -### Changes to stylesheets, scripts and templates |
37 | | - |
38 | | -Any changes made to the css resources, scripts or the template files will automatically be reflected on page refresh. |
39 | | - |
40 | | ---- |
41 | | - |
42 | | -## Testing |
43 | | - |
44 | | -### Prerequisites |
45 | | - |
46 | | - * Java JDK or JRE (http://www.oracle.com/technetwork/java/javase/downloads/index.html) |
47 | | - |
48 | | -### Setup |
49 | | - |
50 | | -To run tests locally with Selenium: |
51 | | - |
52 | | -```sh |
53 | | -npm test |
54 | | -``` |
55 | | - |
56 | | -To change the default auth server edit `server/config/*.json` on your deployed instance. |
57 | | - |
58 | | -```json |
59 | | -{ |
60 | | - "fxaccount_url": "http://your.auth.server.here.org" |
61 | | -} |
62 | | -``` |
63 | | - |
64 | | -**Note that testing with Selenium via Docker does *not* work at present, so all testing must be carried out via your normal operating system's npm & Java tooling.** |
65 | | - |
66 | | ---- |
67 | | - |
68 | | -## Grunt Commands |
69 | | - |
70 | | -[Grunt](http://gruntjs.com/) is used to run common tasks to build, test, and run local servers. |
71 | | - |
72 | | -| TASK | DESCRIPTION | |
73 | | -|------|-------------| |
74 | | -| `grunt build` | build production resources. See [task source](grunttasks/build.js) for more documentation | |
75 | | -| `grunt clean` | remove any built production resources. | |
76 | | -| `grunt lint` | run ESLint, Sass-lint, amdcheck and JSONLint on client side and testing JavaScript. | |
77 | | -| `grunt server` | run a local server running on port 3030 with development resources. | |
78 | | -| `grunt server:dist` | run a local server running on port 3030 with production resources. Production resources will be built as part of the task. | |
79 | | -| `grunt test` | run local Intern tests. | |
80 | | -| `grunt version` | stamp a new minor version. Updates the version number and creates a new CHANGELOG.md. | |
81 | | -| `grunt version:patch` | stamp a new patch version. Updates the version number and creates a new CHANGELOG.md. | |
82 | | - |
83 | | ---- |
84 | | - |
85 | | -## Servers |
86 | | - |
87 | | -* latest development - https://latest.dev.lcip.org/ |
88 | | -* stable - https://stable.dev.lcip.org/ |
89 | | -* stage - https://accounts.stage.mozaws.net/ |
90 | | -* production - https://accounts.firefox.com/ |
91 | | - |
92 | | ---- |
93 | | - |
94 | | -## License |
95 | | - |
96 | | -MPL 2.0 |
| 1 | +# This repository has been migrated to https://github.com/mozilla/fxa/tree/master/packages/fxa-content-server |
97 | 2 |
|
| 3 | +Please file issues and open pull requests against https://github.com/mozilla/fxa |
0 commit comments