Skip to content

README.md

Latest commit

 

History

History
76 lines (48 loc) · 1.25 KB

README.md

File metadata and controls

76 lines (48 loc) · 1.25 KB

🎹 flowkey - Web Client Coding Challenge

This project is a React + TypeScript application using Vite, Bootstrap, and Apollo GraphQL Client.

📌 What's Available

  • 🚀 React
  • 🎨 Bootstrap
  • 🔗 GraphQL (Apollo Client)
  • 🧪 Testing – Jest + React Testing Library
  • ✨ Linting

🚀 Getting Started

1️⃣ Install Dependencies

npm install

2️⃣ Start the Development Server

npm run dev

Open http://localhost:5173/ in your browser.

🔗 GraphQL API

The GraphQL API is available at:

http://localhost:4000/graphql

In order to use it you need to start the server (check README to setup)

cd ../server
npm start

🧪 Testing

This project includes Jest and React Testing Library.

Run Tests

npm run test

Run Tests in Watch Mode

npm run test:watch

🔹 You are free to set up your own testing tools if preferred.
🔹 Writing tests is encouraged but not mandatory.

⚙️ Flexibility

  • The project is preconfigured with GraphQL, but if you prefer another API (e.g., REST), you’re free to use it.
  • You can modify the setup and use any state management, styling, or testing approach you're comfortable with.