Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vikyw89/djangoninja-playground


https://github.com/vikyw89/djangoninja-playground

Last synced: 2 days ago
JSON representation

Awesome Lists containing this project

README

        

# Django Ninja Playground

[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](LICENSE)
[![Python Version](https://img.shields.io/badge/python-3.12-blue.svg)](https://www.python.org/downloads/)
[![Django Ninja](https://img.shields.io/badge/Django%20Ninja-latest-green.svg)](https://django-ninja.rest-framework.com/)

## Description

Welcome to the Django Ninja Playground! This repository serves as a sandbox for experimenting with the powerful and lightweight Django Ninja framework. Here, you can find a collection of sample projects, snippets, and tutorials that showcase the capabilities of Django Ninja for building robust and efficient REST APIs.

## Getting Started

### Prerequisites

- Python 3.6 or higher
- Django 3.2 or higher
- Django Ninja

### Installation

1. Clone the repository:
```bash
git clone https://github.com/yourusername/django-ninja-playground.git
```

2. Install the dependencies:
```bash
cd django-ninja-playground
pip install -r requirements.txt
```

3. Run the development server:
```bash
python manage.py runserver
```

### Usage

Explore the different directories within the repository to find examples of various API endpoints, authentication methods, and data serialization techniques. Each directory contains a README file with specific instructions and explanations.

## Contributing

Contributions are welcome! If you have a cool project or snippet that you'd like to share, please submit a pull request. Make sure to follow the contribution guidelines outlined in the `CONTRIBUTING.md` file.

## License

This project is licensed under the MIT License - see the `LICENSE` file for details.

## Acknowledgments

- [Django Ninja](https://django-ninja.rest-framework.com/) - The framework that powers this playground.
- [Django](https://www.djangoproject.com/) - The high-level Python Web framework that encourages rapid development and clean, pragmatic design.

Happy coding!