Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/oguntayomicheal/loan-app-backend

Take home assignment for 02 tech consulting software developer intern role
https://github.com/oguntayomicheal/loan-app-backend

Last synced: 25 days ago
JSON representation

Take home assignment for 02 tech consulting software developer intern role

Awesome Lists containing this project

README

        

# πŸ“— Table of Contents
- [πŸ“– Loan Application Backend Repository](#-about-project)
- [Link to the front-end repo](#link-to-the-front-end-repo)
- [πŸ›  Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [πŸ’» Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [πŸ‘₯ Authors ](#-authors-)
- [πŸ”­ Future Features ](#-future-features-)
- [🀝 Contributing ](#-contributing-)
- [⭐ Show your support ](#-show-your-support-)
- [πŸ™Acknowledgments ](#acknowledgments-)
- [πŸ“ License ](#-license-)

# πŸ“– Loan Application Backend Repository

> This repository houses the backend code for the Loan Application web application. It's developed in Ruby on Rails and handles database management, user authentication, and serving data to the frontend. The README provides details on setting up the backend, running migrations, and contributing to the project's development.

##### [Link to the front-end repo](https://github.com/oguntayomicheal/Loan-App-Front-end)

## Database Entity Relationship Diagram
![Loan_app_database_diagram](./Loan_App_Entity_Relationship_Diagram.png)

## πŸ›  Built With

### Tech Stack

Back-end Server

Database

(back to top)

### Key Features

##### **Loan Officer (Staff)**
- Permit Staff Login with unique ID
- Renders all Loan applications for Staff dashboard
- Renders each Loan applications
- Permit Update of loan application for staff alone

##### **Customer**
- Permit customer account registration
- Permit Login to an existing customer account
- Permit creating of new loan application
- Renders all applied loans to customer
- Renders each loan applicaitons with its status and details

(back to top)

## πŸ’» Getting Started

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

- Install Ruby
- Install Rails
- Install Postgresql

### Setup

Clone this repository to your desired folder:

```sh
git clone [email protected]:oguntayomicheal/Loan-App-Backend.git
cd Loan-App-Backend
```

### Install

Install this project with:

```sh
bundle install
```

```sh
gem install --no-document rubocop -v '>= 1.0, < 2.0'
```

### Usage

To run the project, execute the following command:

```sh
rails db:create
rails db:migrate
rails server -p 3100
```
### Run tests

To run tests, run the following command:

```sh
rspec spec
```

## πŸ‘₯ Author

πŸ‘€ **Micheal Oguntayo**

- GitHub: [@oguntayomicheal](https://github.com/oguntayomicheal)
- Twitter: [@OguntayoMicheal](https://twitter.com/Oguns_micky)
- LinkedIn: [@OguntayoMicheal](https://www.linkedin.com/in/ogunsmicky/)

## πŸ”­ Future Features

- **Allow customer to delete rejected loan applications**

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/oguntayomicheal/Loan-App-Backend/issues).

## ⭐ Show your support

If you like this project please show support by staring :star:️.

## πŸ™Acknowledgments

- I would like to express my gratitude to [02techconsulting](https://www.02herotechconsulting.com/) for providing the project requirements and making this project possible.

## πŸ“ License

This project is [MIT](./LICENSE) licensed.

(back to top)