fxa/packages/fxa-profile-server
Barry Chen 9593c9f0e5
Release 1.223.2
2022-01-11 17:18:14 -06:00
..
bin refactor(db): created a new package for all db migrations 2021-09-08 13:10:38 -07:00
config refactor(config): replace 127.0.0.1 with localhost 2020-04-15 13:55:42 -07:00
docs feat(aet): make either precondition header mandatory when updating anon id 2020-07-30 11:27:01 -04:00
lib feat(fxa-shared): Allows sentry events for critical endpoints to be 'tagged' as such. 2021-12-16 13:49:11 -08:00
scripts chore(deps): switch from git to https for deps (#11587) 2022-01-11 16:28:42 -06:00
test fix(profile): drop profileCache if the avatar changes 2021-04-22 14:07:58 -04:00
.eslintrc task(monorepo): eslint consolidation 2019-11-15 23:24:09 +00:00
.nsprc refactor(profile): Update to Hapi 19.1.1 2020-03-26 15:03:07 -04:00
.prettierignore chore(style): added prettier to fxa-profile-server 2019-06-25 09:36:41 -07:00
CHANGELOG.md Release 1.223.2 2022-01-11 17:18:14 -06:00
CONTRIBUTING.md chore(docs): Replace 'master' with 'main' throughout 2020-06-25 13:44:28 -07:00
LICENSE init profiles 2014-02-04 12:27:40 -08:00
README.md refactor(profile): replaced graphicsmagick with sharp 2020-09-16 13:59:51 -07:00
package.json Release 1.223.2 2022-01-11 17:18:14 -06:00
pm2.config.js chore(pm2): Add ISO timestamp to pm2 log lines 2020-06-17 17:01:16 -07:00

README.md

Firefox Accounts Profile Service

A server to provide common profile-related data for a Firefox Account. Such as name, avatar, location, age, gender, etc.

Development

Installation:

git clone https://github.com/mozilla/fxa-profile-server
cd fxa-profile-server
npm install

Docker Based Development

To run the profile server via Docker, two steps are required:

$ docker build --rm -t mozilla/fxa_profile_server
$ docker run --rm -v $PWD:/opt/fxa mozilla/fxa_profile_server npm install
$ docker run --rm -v $PWD:/opt/fxa --net=host mozilla/fxa_profile_server

This method shares the codebase into the running container so that you can install npm and various modules required by package.json. It then runs profile-server in a container, while allowing you to use your IDE of choice from your normal desktop environment to develop code.

Running tests:

npm test

To run tests via Docker:

docker run --rm -v $PWD:/opt/fxa --net=host mozilla/fxa_profile_server npm test

Running the server locally:

npm start

License

MPL v2.0