/kyra-full-stack

A Full-Stack React and Node.Js app that retrieves nearby places using Foursquare API. You can filter by category so you can look for that sweet spot for a special occasion.

Primary LanguageTypeScript

Kyra Full-Stack

Find out the best spots near you with Kyra Full-Stack, built React and Typescript

screenshot

Browse through relevant nearby places and spots and find the one you want! You can also filter by category so you can really look for that sweet spot for a special occasion.

Built With

  • Typescript
  • React.Js
  • Node.Js
  • Foursquare
  • MaterialUI

Live Demo

Live Demo Link

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  • Node.Js
  • Yarn or NPM
  • Docker
  • Browser of any choice

Setup

  1. Clone repo git clone https://github.com/mrnadaara/kyra-full-stack.git

  2. Go to repo directory cd kyra-full-stack

  3. Install root dependencies yarn install

  4. Install frontend and backend dependencies yarn setup

  5. Generate .env for the backend directory by running yarn generate:env

  6. Fill in your Foursquare API credentials

Usage

  • Start development server
    • NPM/Yarn
      • To run both backend and frontend, simply run yarn dev in the root directory
      • You can alternatively run them both separately.
      • yarn backend:dev for the backend
      • yarn frontend:dev for the frontend
    • Docker
      • Run yarn docker:dev to build and run a compose project

Deployment

Project was deployed to AWS

CI/CD

Continuous integration was implemented using Github Actions

Testing

  • For Node.JS integration and unit testing, run yarn backend:test

Author

👤 Sharmaarke Ahmed

📝 License

This project is MIT licensed.