Skip to content

Aravind55597/TT-11

Repository files navigation

DBS TechTrek 1

This repository is meant for DBS TechTrek 1. Please follow the instructions of the organizers.

REST API Documentation

Authentication

POST /auth/login

Request Body: 

    {
        "Username",
        "Password"
    }

### Get list of Bank account by UserID
GET /accounts/<UserID>

### Get list of Transactions by AccountID
GET /transactions/<UserID>

### Get User details by UserID
GET /user/<UserID>

### Create a new Scheduled Transaction
POST /transaction/


    ```
    Request Body: 

        {
            “AccountID” , 
            “ReceivingAccountID” , 
            “Date” , 
            “TransactionAmount” , 
            “Comment” , 
        }


    ```


### Delete Scheduled Transaction by TransactionID
DELETE /transaction/<TransactionID>

### Provide, change or remove their address and email
PUT /user/<UserID>


    ```
        Request Body: 

        {
            "Address",
            "Email"
        }

    ```

### Initial Set Up

# Environment variables (.env values for backend)

| Environment Variable  | Value |
| ------------- | ------------- |
| SQLALCHEMY_DATABASE_URI  | mysql://username:hostname:port/Bank |
| JWT_SECRET_KEY  | jwt_secret_key  |
| FLASK_RUN_PORT | 5000  |
| FLASK_RUN_HOST  | 0.0.0.0  |

### FRONTEND GUIDE 

	
1) 
	```
	cd frontend
	```
	
	
2) 
	```
	npm install 
	```

3) 
	```
	npm start
	```


### BACKEND GUIDE 


1) 
	```
	cd backend
	```
	
	
2) 
	Install pipenv  https://pypi.org/project/pipenv/ 

3) 
	```
	pipenv install
	```

4) 
	```
	pipenv run start
	```

About

Tektrek 1 December Group 11

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 7