/Search-Engine

Repository for the phattest search engine ever

Primary LanguageJava

Phat Search Engine

How to contribute

Backend

How to run

  1. Change directory into root of Maven project
cd search-engine/application
  1. Compile the Maven project and run it:
mvn clean package
java -jar target/engine-0.1.jar

Alternatively, you can run the mvn exec plugin (faster):

mvn compile exec:java

Note: if you don't have Maven installed, use the Maven wrapper instead. Example:

./mvnw clean package

If you need to grant permissions on Mac for the Maven wrapper:

chmod a+x mvnw

Deploying to server

  1. Compile the Maven project
mvn clean package
  1. Place the jar file in the server
scp ./target/engine-0.1.jar root@phatsearch.net:/root/applications/Search-Engine
  1. Restart the jar file (while logged into server)
service search-engine restart
  1. Test (while logged into server)
curl localhost:8080

Frontend

Note: The frontend is using Bootstrap 4. Please only use Bootstrap 4!

How to run

  1. Change into the root directory of the frontend
cd search-engine/application/src/main/frontend
  1. Install the dependencies
npm install
  1. Run and go to localhost:8080 (or 8081):
npm run start

How to output the bundle that Spring Boot backend reads from

npm run build