Git Product home page Git Product logo

bcvm's Introduction

BCVM Back End API

Version Spring Boot Version Java Version GitHub last commit

The back end REST API for the BC Vending Machines app. This uses Spring Boot 2.6.4 alongside Java 8. The production build is deployed on Heroku at bcvm.herokuapp.com. The Angular front end is available in the master branch of the BCVM repo.

Running the Application

Spring Boot on port 8080

For development, use api-develop. api-develop includes "Local configuration" in api/src/main/resources/application.yaml and a Captcha class. For production, it must be commented out, and it uses System.getenv("SECRET_KEY") instead of the class.

IntelliJ IDEA was used to create and maintain this API. To run the server, check out the api-develop branch in a Java IDE and run it that way. Or, run mvn spring-boot:run. This requires some setup via installing Maven, cd'ing into the directory where pom.xml is located in, and running mvn spring-boot:run. This may help.

PostgreSQL on port 5432

Install PostgreSQL here. A default option is starting it when your PC boots up. This initializes the connection. You can also start it in Windows Services. Locally, the project intends to connect to a Postgres database called "postgres" that runs on the default port 5432. You may need to populate the database with the schema.sql followed by the data.sql SQL file in api/src/main/resources.

Full development stack (ports 5432, 8080, 4200)

If you're not just testing endpoints, you will need to set up the front end, so check out the README in the master branch.

bcvm's People

Contributors

zachneill 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.