Skip to content

This is a Hackathon Project. It provides web service. ReCykle is a concept to share our extra food, book, cloths to need the needy ones instead wasting it by throwing away.

Notifications You must be signed in to change notification settings

starving-array/ReCykle-App-PowerToFly-Diversity-Hackathon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 

Repository files navigation

ReCykle PowerToFly Diversity Hackathon

Er Diagram

This is a springboot project which provide Web Service (REST API).

How to use?

As this is a rest API project, client part hasn't added to it. But you can use Swagger or Postman to play with the API. And also you can use this API with your frontend project. As it will be on localServer on your PC you need to keep the server on while playing with it. Steps given below for additional info,

1. CREATE database ecom;

Create a database on your local system. If you don't have MySQL installed, kindly install it first.

Once Installed please set/keep your mysql credentials as below

username: root
password: root

and create the database as mentioned above. Database name-> blogApp;

2. git clone https://github.com/starving-array/E-Commerce-Rest-API.git;

Clone this repo to your local system and open STS to import and run the project. If you don,t have STS IDE on your system, kindly download STS.

3. Open STS and Import the Project;

File -> Open Projects from File Systems -> Directory

  • Browse to the location where you have cloned this project. And select blog-api

Next-> Finish. It might take a few minutes to download all the dependencies on your local system. You can check the progress bar at righ-down corner.

Once finished update the Maven project to make sure all the dependencies have downloaded.

Right Click on blog_api at package exporer on leftside window, Maven -> Update Project -> check Force Update on SnapShots/releases -> Ok

Congratulation, you've successfully imported the project on your system

4. Start the Spring Boot App Server;

Right Click on blog_api at package exporer on leftside window, Run as -> Spring Boot App

You can see the process as a console window will be opening below.

5. http://localhost:8088/swagger-ui/;

Open this link on broswer. It will open the Swagger UI. You can play with All the API there.

6. STOP the server;

Once you are done with playing, click on the red square box on top of the console to stop the server.

Important Facts,

  1. The port for this application has set 8080. You can change it from Application Properties in resource folder, or stop any other running app before starting this as it can create conflict for same port that you might be using coincedently.

#changing the server port
server.port=8088

  1. _Incase if have different root name and password for mysql in your system, you change this application username and password from Application Properties.

# MySql username and Password
spring.datasource.username=root
spring.datasource.password=root

API names and Use=>

**UUID used as security param to authenticate user and maintain security.

1. User-controller:

  • createAccountH : Create a new account.
  • updateAccountH : Modify your account

1.1 Login-controller:
  • logInUser : Login with Contact No and Password. This will genarate a UUID to control activity and it will also maintain security.
  • logoutUser : Session will be deleted, (UUID) once you have logged out.
  • getAccountDetails : With UUID and account id as parameters, it will match if the user is same and return user detail.

About

This is a Hackathon Project. It provides web service. ReCykle is a concept to share our extra food, book, cloths to need the needy ones instead wasting it by throwing away.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages