fxa/packages/fxa-profile-server
Lauren Zugai 02c19ef4b4
Merge pull request #14652 from mozilla/train-247
Release 1.247.4 -> main
2022-12-19 15:31:37 -06:00
..
bin feat(fxa-profile-server): add OpenTelemetry library to profile server 2022-09-21 14:43:21 -07:00
config
docs maintenance(auth,profile,settings,shared): Remove AET 2022-04-01 15:10:04 -07:00
lib task(content): Add support for tracing on client side 2022-10-10 14:14:32 -07:00
scripts task(ci): Tag unit tests 2022-12-09 17:26:27 -08:00
test task(ci): Tag unit tests 2022-12-09 17:26:27 -08:00
.eslintrc task(content): Add support for tracing on client side 2022-10-10 14:14:32 -07:00
.nsprc
.prettierignore
CHANGELOG.md Merge pull request #13572 from mozilla/FXA-5496-stop-generating-changelogs-in-our-release-script 2022-07-11 16:20:36 -07:00
CONTRIBUTING.md
LICENSE
README.md
package.json Merge pull request #14652 from mozilla/train-247 2022-12-19 15:31:37 -06:00
pm2.config.js feat(fxa-profile-server): add OpenTelemetry library to profile server 2022-09-21 14:43:21 -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