fxa/packages/fxa-profile-server
Dan Schomburg e3fe3ca31a
Merge pull request #17946 from mozilla/dependabot/npm_and_yarn/joi-17.13.3
chore(deps): bump joi from 17.8.3 to 17.13.3
2024-11-08 16:51:21 -08:00
..
bin feat(promo): Add conditional for ProductPromo for Mozilla Monitor Plus 2024-08-07 11:51:37 -04:00
config refactor(config): replace 127.0.0.1 with localhost 2020-04-15 13:55:42 -07:00
docs chore(many): Remove npm run commands 2023-05-17 11:24:09 -07:00
lib deps(sentry): upgrade Sentry to version 8 2024-09-25 12:31:19 -07:00
scripts task(CI): Improve nx caching for CI pipelines 2023-08-29 11:19:54 -07:00
test fix(auth,profile): Fix missing event broker events 2023-06-01 16:44:59 -07:00
.eslintrc chore(build): initial nx implementation 2023-05-23 08:37:47 -07: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
README.md chore(many): Remove npm run commands 2023-05-17 11:24:09 -07:00
backstage.yaml fix(backstage): update db references, add gql API ref 2024-01-26 08:41:53 -08:00
package.json Merge pull request #17946 from mozilla/dependabot/npm_and_yarn/joi-17.13.3 2024-11-08 16:51:21 -08:00
pm2.config.js chore(deps): upgrade to node.js 18 2023-03-20 13:28:10 -05: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
yarn 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 yarn 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