Find out the best spots near you with Kyra Full-Stack, built React and Typescript
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.
- Typescript
- React.Js
- Node.Js
- Foursquare
- MaterialUI
To get a local copy up and running follow these simple example steps.
- Node.Js
- Yarn or NPM
- Docker
- Browser of any choice
-
Clone repo
git clone https://github.com/mrnadaara/kyra-full-stack.git
-
Go to repo directory
cd kyra-full-stack
-
Install root dependencies
yarn install
-
Install frontend and backend dependencies
yarn setup
-
Generate .env for the backend directory by running
yarn generate:env
-
Fill in your Foursquare API credentials
- 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 backendyarn frontend:dev
for the frontend
- To run both backend and frontend, simply run
- Docker
- Run
yarn docker:dev
to build and run a compose project
- Run
- NPM/Yarn
Project was deployed to AWS
Continuous integration was implemented using Github Actions
- For Node.JS integration and unit testing, run
yarn backend:test
👤 Sharmaarke Ahmed
- Github: @mrnadaara
- Twitter: @mrnadaara
- Linkedin: Sharma'arke Ahmed
This project is MIT licensed.