rickfurt / postcode-search

Check postcode with AusPost API.

Postcode Search

This project consists in an API integrated to AusPost to check if the Suburb name is valid or to check if the postcode is valid

Stack:

• ReactJs
• ExpressJs
• Jest
• Parcel
• Github Actions
• Others

Getting started

After cloning this repository, run:

npm install

Testing

Using Jest as testing framework.

How to run the tests?

npm test

How to continuously run tests?

npm run test:watch

Running application Server + Client simultaneously

Before run the server there's a prerequirement

• In order to be able to use the AusPostAPI is need to setup the AUTH_KEY as an enviroment variable.

To do that simply add a file called .env to the root's project and set the key to the variable.

Example: AUTH_KEY='Here goes your api key'

Now we can run the application

For this action the application is using concurrently.

Run:

npm run dev

This command allows the user to run the server and client in one script only.

After this command simply open your browser on this path