README.md

City Scanner

Introduction

City Scanner is a web based platform for students to explore new places before moving there for education.

Technologies used:

Java, Spring Boot, React JS, CSS, MySQL, Google Maps API, Git, Jira

Prerequisite:

Java 8: https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
ReactJS setup: https://www.robinwieruch.de/react-js-windows-setup

Any editors of your choice

Instructions to run the Project:

Clone the repository:

git clone https://github.iu.edu/P532Fall19/City-Source.git

Database setup:

Create database named city in MySQL using command line or workbench and create all the tables required for project. (Find all the schemas in Table_Schema.pdf).

Import Backend/Cityscanner to eclipse:

open eclipse -> File -> import -> projects from folder or archive -> directory -> locate the project -> finish

Application.properties file setup:

Make sure all the properties are correct for database connectivity.

Maven build: Builds the project

Right click on project -> Run as -> mvn build

Maven install: Downloads all dependencies

Right click on project -> Run as -> mvn install

Running the application

1. Find the src/main/java and the right Click on it and the Run As -> Spring Boot App

Import City-Scanner-UI/project to Visual Studio Code

open Visual Studio Code -> File -> Open Folder -> directory -> locate the project -> finish

Install react dependencies

Terminal -> New Terminal or control + shift + `. Go to terminal and then go to project and run following command:

npm install

Running the React application

Go to terminal and run following command to launch the react application:

npm start