Skip to content

Sprou-t/cs203

Repository files navigation

TarrifEase

A secure todo application with JWT authentication, built with Spring Boot and PostgreSQL.

🚀 Quick Start

New to the project?

  1. 📚 Read the Documentation - Complete setup and development guides
  2. 🔧 Setup Your Environment - Get running in minutes
  3. 🗄️ Connect to Database - AWS RDS PostgreSQL

🏗️ What's This Project?

CS203 is a full-stack todo application featuring:

  • Secure Authentication - JWT-based user registration and login
  • User-Owned Data - Each user can only access their own todos
  • External APIs - Integration with WITS trade data API
  • Cloud Database - AWS RDS PostgreSQL for reliable data storage
  • Modern Architecture - Spring Boot backend with planned React frontend

🛠️ Tech Stack

  • Backend: Spring Boot 3.x, Spring Security, JPA/Hibernate
  • Database: PostgreSQL (AWS RDS)
  • Security: JWT tokens, BCrypt password hashing
  • Build: Maven
  • APIs: WITS (World Integrated Trade Solution)

📚 Documentation

All documentation is organized in the docs/ folder:

Document Purpose
Main Documentation Complete project documentation index
Backend Setup Get your development environment running
Database Setup Connect to AWS RDS PostgreSQL
Feature Development Build secure features with authentication
Git Workflow Team development process

🎯 For Developers

Backend Developers

  1. Start with Backend Setup Guide
  2. Connect to database with Database Setup
  3. Learn development patterns with Feature Development

New Contributors

  1. Read the Git Workflow for team process
  2. Follow the Backend Setup to get running
  3. Check the Project Structure to understand the codebase

👥 Team: SinSinAlliance

This project is developed collaboratively using git branching and pull requests. See our Git Workflow for contribution guidelines.

📞 Getting Help

  1. Check the docs first - most questions are answered there
  2. Review troubleshooting for common issues
  3. Ask in team chat with specific error messages
  4. Create an issue for bugs or feature requests

Ready to build something awesome? Start with the documentation! 🚀

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors