Giter VIP home page Giter VIP logo

oc_p6_paymybuddy's Introduction

README

This app is an exercise about creating a template app to make money transaction between buddies.
The point here is to create the frontend and the backend (i.e. db construction).
Nothing is set in place to make real financial transaction.

Before use

  1. Read Database documentation
  2. Read application.properties documentation
  3. How to launch documentation

Database documentation

Main database : paymybuddy

This app uses a MySQL DB. Here are some information about how to install this DB.

  1. Download and install MySQL : https://dev.mysql.com/downloads/installer/
  2. Record carefully your RootUsername and password to this DB.
  3. Open a command prompt :
    1. type in and press ENTER: mysql -u 'yourRootUsername' -p
    2. write down your password when asked and press ENTER
    3. type in and press ENTER : CREATE DATABASE paymybuddy;
    4. type in and press ENTER : exit
    5. locate both data.sql and schema.sql. They are normally inside resources file of this project.
    6. Go back to your prompt and type in + Enter :
      1. mysql -u username -p database_name < {full path to schema.sql}
    7. You are now good to go, and have correctly initialised your database

Test database : paymybuddytest

  1. Open a command prompt where createTestUser.sql is located (normally in tests resources) :
    1. type in and press ENTER: mysql -u 'yourRootUsername' -p
    2. write down your password when asked and press ENTER
    3. type in and press ENTER : CREATE DATABASE paymybuddytest;
    4. type in and press ENTER : exit
    5. type in : source createTestUser.sql
    6. press ENTER.
    7. Enjoy !

Application.properties documentation

This file is located in src/main/resources.
It is used to give properties to the spring boot application. In this project there is already one called application.example.properties.

  1. If you want to use this app through it sources files:
    1. Duplicate application.example.properties and rename it application.properties. Make sur it is located in src/main/resources
    2. add the correct values for each property :
      1. spring.datasource.username
      2. spring.datasource.password
      3. spring.datasource.url
      4. spring.jpa.properties.hibernate.dialect
      5. All the entries concerning ### OAuth2.0 ###
  2. If you use the jar file:
    1. Create a /config directory in the root directory where the jar is located.
    2. add application.properties in this /config directory
    3. follow steps above to configure application.properties

Enjoy !

How To launch

  • If you want to launch the app, you can launch the sources with your favorite IDE. Or you can launch the .jar file with you command prompt.
  • Then use you internet browser and go to 'localhost:8080' to get into the app (tested on firefox).
    • the 8080 port can be changed into the application.properties mentioned above.
    • Here is the admin account by default in the app :

Diagrams

UML diagram

UML diagram

PDM diagram

PDM diagram

oc_p6_paymybuddy's People

Watchers

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