Skip to content

nahom-d54/Unisource

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

281 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Unisource

Unisource is a full-stack web application designed to manage and share resources, featuring user authentication, resource uploads, reviews, ratings, and category management. The project is organized into a Django backend and a Next.js frontend, with Docker support for deployment.

Project Structure

Unisource/
├── backend/      # Django backend (API, models, authentication)
├── frontend/     # Next.js frontend (UI, components, hooks)
├── docker-compose.yml
├── nginx.conf

Backend

  • Framework: Django
  • Location: backend/
  • Features:
    • RESTful API for resources, users, reviews, ratings, and categories
    • Authentication and permissions
    • SQLite database (default)
    • Custom management commands

Frontend

  • Framework: Next.js (TypeScript)
  • Location: frontend/
  • Features:
    • Modern UI with Tailwind CSS
    • Resource browsing, uploading, and reviewing
    • User authentication and profile management
    • Dashboard and category navigation

Deployment

  • Docker: Use docker-compose.yml for multi-container setup
  • Nginx: Reverse proxy configuration in nginx.conf

Getting Started

Prerequisites

  • Docker & Docker Compose
  • Node.js & pnpm (for frontend development)
  • Python 3.10+ (for backend development)

Backend Setup

cd backend
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt
python manage.py migrate
python manage.py runserver

Frontend Setup

cd frontend
pnpm install
pnpm dev

Docker Setup

docker-compose up --build

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

See backend/LICENSE for details.

Contact

For questions or support, contact the repository owner.

About

An api which stores different resources for university students

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors