ronix-backend

BACKEND MUSIC streaming API
Checkout Step by step tutorial »

View Demo · Report Bug · Frontend Repo Vuejs

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact

About The Project

Image credits to its respective creators

There arent great tutorials that teaches Django + Vuejs , So, I created this to show the capability of Django and how easy it is to build enterprise level applications with Django and Vuejs.

Built With

This section lists major frameworks which we used to built this project.

• Vuejs
• Django
• Django REST Framework

Getting Started

To get a local copy and running up follow these simple steps.

Prerequisites

We need the following.

• Python3.
• git.

Installation

1. Clone the repo

git clone https://github.com/Adarshreddyash/ronix-backend.git

2. Install python packages

pip install -r requirements.txt

3. Make migrations

python manage.py makemigrations

4. Run

python manage.py runserver

Usage {endpoints}

Songs

127.0.0.1:8000/api/v1/songs

Authentication

127.0.0.1:8000/rest-auth/registration/
127.0.0.1:8000/rest-auth/login/

JWT Tokens

127.0.0.1:8000/api/v1/auth/obtain_token/
127.0.0.1:8000/api/v1/auth/refresh_token/

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Twitter - @adarshreddyash

Project Link: https://github.com/Adarshreddyash/ronix-backend