Code Monkey home page Code Monkey logo

spaghetti's Introduction

Spaghetti (eHotels Backend)

uOttawa CSI 2132 Winter 2024 Course Project
Group Members: Aiden Garrett (300293059), Kelly Song (300287703), Andy Yep (300291757)

About

eHotels is a very rudimentary hotel booking system.

This is the backend (REST API server and JDBC interface) for the eHotels system. Click here for the frontend source code.

Configuration

Before building/starting the backend, make sure you have a DBMS user created for use in PostgreSQL.

Then, make a copy of the application.properties.template file, fill out the empty fields as outlined, and rename the file to application.properties. This file is located in the resources folder (src/main/resources).

Compiling

Ensure you have JDK 17 and PostgreSQL installed. You'll also need gradle, though you can opt to use the copy that's bundled with the source code (gradlew).

IntelliJ IDEA

The easiest way to run the backend is probably through the IDE.

If you're reading this README file in IntelliJ IDEA, you can simply start the application by clicking the play button below:

Spaghetti

If the button above didn't work, simply open the Spaghetti class and click on the "Run" button that appears beside the following line:

    public static void main(String[] args) {...}

(located at src/main/java/ca/uottawa/csi2132/group196/spaghetti/Spaghetti.java)

Command Line

Alternatively, if you don't have IntelliJ IDEA installed or don't feel like running it through that, you can do it through the command line.

Running Directly From Source

In the project root (where the build.gradle file is), run the following command:

gradle bootRun

Running From Jar

You can also build a jar with

gradle bootJar

which will be output to the build/libs folder.

Then run the jar with the java command directly:

cd build/libs
java -jar spaghetti-0.0.1-SNAPSHOT.jar

Swagger

You can view and interact with the endpoints all in one convenient spot with Swagger. To use Swagger, simply go to the following URL:

http://localhost:8080/swagger-ui/index.html

(if you end up changing the hostname, then use the respective hostname)

spaghetti's People

Contributors

gentlytech avatar aiden-garrett avatar kellys008 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.