This project is a simple zipcode search API through GraphQL using Node.js, Typescript and React.js under monorepo architecture, with zippopotam.us free API.
- Operating system: Linux based/MacOS/WSL2 on Windows
- npm 8
- Node.js 16
- Docker
- Docker Compose
# Clone the project using HTTPS
git clone https://github.com/Siipe/zip-challenge-monorepo.git# Prepare database container
docker-compose -f "docker-compose.yml" up -d --build
# Install dependencies
npm install# Start & Watch for API changes (Port 5000)
npm run api
# OPTIONAL: you only need to run this command if you modify GraphQL queries, mutations or schema
npm run gen
# Start frontend (web) React (Port 3000)
npm run web# e2e tests for the GraphQL API
npm run test:api