https://github.com/ezeisraeljohn/mofisafe
This is a financial tracking app
https://github.com/ezeisraeljohn/mofisafe
budget-app django django-application django-project django-rest-api django-rest-framework finance-management
Last synced: 8 months ago
JSON representation
This is a financial tracking app
- Host: GitHub
- URL: https://github.com/ezeisraeljohn/mofisafe
- Owner: ezeisraeljohn
- Created: 2024-05-17T14:41:15.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-03T16:10:21.000Z (about 1 year ago)
- Last Synced: 2025-01-11T18:29:04.975Z (10 months ago)
- Topics: budget-app, django, django-application, django-project, django-rest-api, django-rest-framework, finance-management
- Language: Python
- Homepage:
- Size: 22.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mofisafe - A Financial Tracking App
Welcome to The Mofisafe App. This is a Django application designed to help you manage your finances.
You can visit the deployed site here. For more insights and detailed information, check out the final project blog article here.
## Acknowledgements
- [Tailwind Official Documentation](https://v2.tailwindcss.com/docs)
- [Django Official Documentation](https://docs.djangoproject.com/en/5.0/)
## API Reference
#### To access the Mofisafe API, use the following endpoint. This will take you to our Django REST Framework (DRF) home page, where you can view and interact with all available API endpoints once logged in.
```http
GET /api/v1/
```
## Authentication.
#### Access to the API requires authentication. Ensure that you are logged in to access the full range of API endpoints. You must sign up as a user to login via the DRF hime page
```http
GET api/v1/auth/
```
## Authors
- [@Ughagwu Oluchukwu](https://github.com/oluchristian)
- [@Eze Israel John](https://github.com/ezeisraeljohn)
- [@Sanele Skhosana](https://github.com/sanzamcmillian)
## Installation
To get a local copy up and running, follow these simple steps.
```bash
git clone https://github.com/ezeisraeljohn/mofisafe.git
cd mofisafe
```
Create a virtual environment.
```bash
python -m venv venv
```
Activate the virtual environment.
```bash
source venv/bin/activate
```
Install dependencies.
```bash
pip install -r requirements.txt
```
Apply migrations
```bash
python manage.py migrate
```
Apply migrations
```bash
python manage.py migrate
```
Run the development server
```bash
python manage.py runserver
```
## Usage/Examples
Once the server is running, you can access the application in your web browser at http://127.0.0.1:8000/.
## Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request