cmabuza / SpotZA

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SpotZA

Description

This Full-Stack Spotify App is a web application that allows users to explore and discover South African music through the Spotify platform. Built with Python, Django, Tailwind CSS, PostgreSQL, and deployed on Zeet, this project aims to showcase the richness of South African music while demonstrating advanced software development techniques.

Features

  • User Authentication
  • Comprehensive Unit Tests for Backend Functionality using Django's Testing Framework
  • Django's Caching Framework
  • HTTPS Enforcement
  • Integration with Spotify API for Music Discovery

Technology Stack

  • Backend Framework: Django
  • Frontend Framework: React.js (optional, for dynamic UI)
  • CSS Framework: Tailwind CSS
  • Database: PostgreSQL
  • Deployment: Zeet

Setup Instructions

  1. Clone the repository:
    git clone https://github.com/your-username/SpotZA.git
    

Setup Django project:

  1. Enter the repository:
    cd SpotZA
    pip install -r requirements.txt
    

Run migrations and start the development server:

  1. Run the following commands:
    python manage.py migrate
    python manage.py runserver
    

Access the application:

Access the application in your browser at http://localhost:8000/.

Deployment

This project is deployed on Zeet for seamless deployment and continuous integration/continuous deployment (CI/CD) pipeline. Automatic deployments are triggered upon pushing changes to the main branch.

Contributing

Contributions are welcome! If you'd like to contribute to this project, please open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgments

Special thanks to the Spotify API documentation and the Tailwind CSS framework for simplifying integration and styling.

Contact

For any questions or inquiries, please contact claudiamabuza0@gmail.com.

Enjoy exploring South African music with the SpotZA!

About

License:GNU General Public License v3.0