ACE PIN Reset API

Backend to support web pin changing leveraging the ACE REST API.

This project was generated with NodeJs version 18.10.0 and Express.

The application provides all state management, security wrapping and coverage of the ACE Reset PIN.

Development Environment (Local)

Please review the following when setting up a new environment on your development machine. The following is the requirements for setting up the PIN Reset API so that you can run and debug.

System Requirements

:bulb: Before you begin, make sure you have the following installed:

• Node.js v18 or above
• Git
• Yarn 1.22.19
• WebStorm or Visual Studio Code

Development server API

Build

To build the API without an IDE, you can use the command line.

First, run yarn to setup your node_modules and for yarn to create the yarn.lock file with all of the project package dependencies.

Next, run yarn build to build the project. The build artifacts will be stored in the build/ directory. Use the --prod flag for a production build.

Run

There are three ways that you can run the API Server:

1. Run npm start
2. Run raw, ts-node server/index.ts for a dev server.
3. Use WebStorm and Ctrl-D, or use VS Code and hit F5 (debug)

Any of these 3 ways to start will have an endpoint that you can directly hit by navigating to http://localhost:3000/. The app will automatically reload if you change any of the source files.

Test

Run yarn test to execute the unit tests via Jest.

Further help

To get more help, please contact David Dietrich at [email protected].