Git Product home page Git Product logo

postcode-search's Introduction

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:

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

postcode-search's People

Contributors

dependabot[bot] avatar rickfurt avatar

Stargazers

 avatar

Watchers

 avatar  avatar

postcode-search's Issues

Create Core module

It should validate an address:

  • Postcode should match the suburb.
  • Suburb should match the state.
  • Postcode, suburb and state should match

Create UI

Create User Interface:

Requirements

  • React js.
  • Create an online form.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.