Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ankitjain28may/costexplorer
https://github.com/ankitjain28may/costexplorer
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ankitjain28may/costexplorer
- Owner: ankitjain28may
- Created: 2018-12-03T14:09:46.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-03-26T00:36:59.000Z (over 2 years ago)
- Last Synced: 2024-04-14T06:10:17.997Z (7 months ago)
- Language: PHP
- Homepage: https://cost-explorer.herokuapp.com/
- Size: 284 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cost Explorer
A web application which shows cost explorer to view different types of costs for various projects that your company is working on for multiple clients.
## Installation and Contribution
### Requirements :
1. PHP >= 7.1
2. MySQL >= 5.7
3. Composer
4. Laravel == 5.7.*
### Completed Tasks :
* [x] Set up the database structure.
* [x] Populate the database using the SQL dump given in this [file](https://drive.google.com/file/d/1aF_u32ASu0o6Ah9cdKxPYvj7dDeSnVE-/view?usp=sharing) through Laravel Database Seeding
* [x] Create an endpoint which returns this cost data in the JSON structure given [here](https://jsoneditoronline.org/?id=e29c1e930e3e4cdcab06408c28406df7), by fetching the data from the database.
### Bonus Tasks :
* [x] Add ability to filter the cost data by Client(s), Project(s), and Cost Type(s).
### Usage :
* Endpoint: /cost-explorer
Output: Cost data of all clients and their projects
* Endpoint: /cost-explorer?clients[]=1&clients[]=2
Output: Cost data of clients 1 and 2, and their projects
* Endpoint: /cost-explorer?clients[]=1&clients[]=2&projects[]=1
Output: Cost data of project 1 for clients 1 and 2
* Endpoint: /cost-explorer?cost_types[]=1&cost_types[]=2&cost_types[]=3
Output: Cost data with cost types 1, 2, and 3, for all clients (and their projects)
### Project Setup :
Fork and Clone this repo or download it on your local system.
Open composer and run this given command.
```shell
composer install
composer update
```
After installing composer, Rename the file `.env.example` to `.env`.
```shell
cp .env.example .env
```
> Set db credentials in `.env` and run the following Commands.
Generate the Application key
```php
php artisan key:generate
```
Migrate the database.
```php
php artisan migrate
php artisan db:seed
```
> Run this project on localhost
```php
php artisan serve
```
This project will run on this server:
```shell
http://localhost:8000/
```
### Contribution
1. Fork and clone the repo.
2. Follow the installation procedure to make it run on your local system.
3. Open an issue for adding any feature or to resolve any bug.
4. Make your own branch and send pull request to that branch.