Flashcards (backend)

Django REST API used to build a flashcard backend server that enables CRUD functionality for the React.js frontend.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. Contact
5. Acknowledgements

About The Project

This is the Django REST API used to build a flashcard backend server that will enable CRUD functionality for the React.js frontend. It consists of a Collection model and Card model with Collection as the foreign key. This API interacted with a MySQL database. The Collection views include get and post, while the Card views include get, post, update, and delete methods.

Built With

• Python
• Django Rest Framework
• MySQL
• Postman

Getting Started

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

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• pip

  pip install django==3.1.8

  pip install djangorestframework

  pip install mysql-connector-python==8.0.23

Installation

1. Clone the repo

   git clone https://github.com/Schmidt1519/flashcards-django-rest.git

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

Contact

Leighton Schmidt | LinkedIn | schmidt1519@gmail.com

Backend: https://github.com/Schmidt1519/flashcards-django-rest
Frontend: https://github.com/Schmidt1519/flashcard-react/

Acknowledgements

• devCodeCamp instructors
• My family