diff --git a/README.md b/README.md index e69de29..bd204b5 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,88 @@ +# Full-Stack Learning Project + +This repository is a full-stack learning project focused on building and understanding modern application development practices end-to-end. + +It demonstrates how to design, build, and deploy a real-world application using a backend API, mobile frontend, database integration, and CI/CD workflows. + +--- + +## Tech Stack + +### Backend +- Spring Boot +- RESTful API architecture +- PostgreSQL database + +### Frontend +- React Native (Expo) + +### DevOps / Tooling +- Docker +- CI/CD pipelines (Gitea Actions or similar) +- Git version control + +--- + +## Purpose + +The goal of this project is to gain hands-on experience with: + +- Full-stack application architecture +- Backend API development with Spring Boot +- Mobile development with React Native +- Database design and integration +- Authentication and security concepts +- Containerization with Docker +- Continuous Integration / Continuous Deployment (CI/CD) + +--- + +## Deployment + +The application is deployed on a self-hosted home server for development and testing purposes. + +--- + +## How to Run (Backend) + +To be added. + +Planned steps: +- Install Java and Gradle +- Configure PostgreSQL database +- Set environment variables +- Run Spring Boot application +- Expose API on localhost or network +- I usually run eveything with traefik but i dont know should i include that here??? + +--- + +## How to Run (Frontend) + +To be added... + + +--- + + +## CI/CD + +To be added. + +Planned steps: +- Configure Gitea Actions / CI pipeline +- Build backend and frontend automatically +- Deploy to home server +- Automate testing and builds + +--- + +## Status + +This project is currently under semi-active development as a learning and experimentation environment. + +--- + +## Notes + +This project is just me messing around with stuff while making an app i will use and perhaps others will find it useful