Skip to content

Commit 94bc208

Browse files
Add Configuration files (#79)
* Add Configuration files * Updated dependencies and readme * Added namespace in DatabaseSeeder.php * Update composer.lock * Update package-lock.json * Update laravel.yml * Update laravel.yml * Update laravel.yml * Update composer.json * Update laravel.yml * Update composer.json * Remove unit tests * Update github workflow --------- Co-authored-by: Muhammad Jawaid Shamshad <[email protected]>
1 parent 1c19595 commit 94bc208

19 files changed

+1004
-1137
lines changed

.github/FUNDING.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# These are supported funding model platforms
2+
3+
github: [mjawaids, ibexoft] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4+
patreon: jawaid # Replace with a single Patreon username
5+
# open_collective: # Replace with a single Open Collective username
6+
ko_fi: jawaid # Replace with a single Ko-fi username
7+
# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
# liberapay: # Replace with a single Liberapay username
10+
# issuehunt: # Replace with a single IssueHunt username
11+
# otechie: # Replace with a single Otechie username
12+
# custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/workflows/laravel.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Laravel
2+
3+
on:
4+
push:
5+
branches: [ master ]
6+
pull_request:
7+
branches: [ master ]
8+
9+
jobs:
10+
laravel-tests:
11+
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- uses: actions/checkout@v2
16+
- name: Setup PHP
17+
uses: shivammathur/setup-php@v2
18+
with:
19+
php-version: '8.2'
20+
- name: Copy .env
21+
run: php -r "file_exists('.env') || copy('.env.example', '.env');"
22+
- name: Install Dependencies
23+
run: composer install --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
24+
- name: Generate key
25+
run: php artisan key:generate
26+
- name: Directory Permissions
27+
run: chmod -R 777 storage bootstrap/cache
28+
- name: Create Database
29+
run: |
30+
mkdir -p database
31+
touch database/database.sqlite
32+
# - name: Execute tests (Unit and Feature tests) via PHPUnit
33+
# env:
34+
# DB_CONNECTION: sqlite
35+
# DB_DATABASE: database/database.sqlite
36+
# run: vendor/bin/phpunit

.idx/dev.nix

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{pkgs}: {
2+
channel = "stable-23.11";
3+
packages = [
4+
pkgs.nodejs_20
5+
pkgs.php83
6+
pkgs.php83Packages.composer
7+
pkgs.phpunit
8+
];
9+
idx.previews = {
10+
previews = {
11+
web = {
12+
command = [
13+
"php"
14+
"artisan"
15+
"serve"
16+
];
17+
manager = "web";
18+
};
19+
};
20+
};
21+
}

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Ibexoft
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 55 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,76 @@
1-
<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
1+
# Ibex Wallet
2+
[![Open Source Helpers](https://www.codetriage.com/mjawaids/ibex-wallet/badges/users.svg)](https://www.codetriage.com/mjawaids/ibexpenses)
23

3-
<p align="center">
4-
<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
5-
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
6-
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
7-
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
8-
</p>
4+
(UNDER ACTIVE DEVELOPMENT. NOT EVEN IN 'BETA')
95

10-
## About Laravel
6+
Manage your personal finances, budgets and track your expenses with ease. Get AI based suggestions to spend mindfully and save for your better future. Get regular updates on your spendings and forecast your expenses for coming months and years.
117

12-
Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
138

14-
- [Simple, fast routing engine](https://laravel.com/docs/routing).
15-
- [Powerful dependency injection container](https://laravel.com/docs/container).
16-
- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
17-
- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
18-
- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
19-
- [Robust background job processing](https://laravel.com/docs/queues).
20-
- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
9+
## Prerequisites
2110

22-
Laravel is accessible, powerful, and provides tools required for large, robust applications.
11+
- PHP 8.2 or higher
12+
- Composer
13+
- Node.js and npm
14+
- MySQL or any other supported database
2315

24-
## Learning Laravel
16+
## Setup Instructions
2517

26-
Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
18+
Follow these steps to set up the project locally:
2719

28-
You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.
20+
1. **Clone the repository:**
2921

30-
If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
22+
```bash
23+
git clone https://github.com/Ibexoft/ibex-wallet.git
24+
cd ibex-wallet
25+
```
3126

32-
## Laravel Sponsors
27+
2. **Install PHP dependencies using Composer:**
3328

34-
We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com).
29+
```bash
30+
composer install
31+
```
3532

36-
### Premium Partners
33+
3. **Set up your environment variables:**
3734

38-
- **[Vehikl](https://vehikl.com/)**
39-
- **[Tighten Co.](https://tighten.co)**
40-
- **[WebReinvent](https://webreinvent.com/)**
41-
- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
42-
- **[64 Robots](https://64robots.com)**
43-
- **[Curotec](https://www.curotec.com/services/technologies/laravel/)**
44-
- **[Cyber-Duck](https://cyber-duck.co.uk)**
45-
- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
46-
- **[Jump24](https://jump24.co.uk)**
47-
- **[Redberry](https://redberry.international/laravel/)**
48-
- **[Active Logic](https://activelogic.com)**
49-
- **[byte5](https://byte5.de)**
50-
- **[OP.GG](https://op.gg)**
35+
Copy the example environment file and create a new `.env` file:
5136

52-
## Contributing
37+
```bash
38+
cp .env.example .env
39+
```
5340

54-
Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
41+
Update the `.env` file with your database credentials and other necessary configuration.
5542

56-
## Code of Conduct
43+
4. **Generate an application key:**
5744

58-
In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
45+
```bash
46+
php artisan key:generate
47+
```
5948

60-
## Security Vulnerabilities
49+
5. **Run database migrations & seeders:**
6150

62-
If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.
51+
Ensure your database is running and properly configured in the `.env` file, then run:
6352

64-
## License
53+
```bash
54+
php artisan migrate --seed
55+
```
56+
57+
6. **Install NPM dependencies:**
58+
59+
```bash
60+
npm install
61+
```
62+
63+
7. **Build frontend assets:**
64+
65+
```bash
66+
npm run build
67+
```
68+
69+
8. **Start the development server:**
70+
71+
```bash
72+
php artisan serve
73+
```
74+
75+
The application will be available at `http://localhost:8000`.
6576

66-
The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

composer.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
{
2-
"name": "laravel/laravel",
2+
"name": "ibexoft/ibex-wallet",
33
"type": "project",
4-
"description": "The skeleton application for the Laravel framework.",
5-
"keywords": ["laravel", "framework"],
4+
"description": "Ibex-wallet - Manage your personal expenses",
5+
"keywords": [
6+
"framework",
7+
"laravel"
8+
],
69
"license": "MIT",
710
"require": {
811
"php": "^8.2",

0 commit comments

Comments
 (0)