Flashcards (frontend)

Flashcards React frontend that consumes a web API created with Django Rest Framework. My first project using React Hooks.
Explore the docs »

Report Bug · Request Feature

Table of Contents

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

About The Project

Flashcards is a CRUD application allowing the user to select a collection from a list and click through each card in the collection to see the term and definition. This was my first project utilizing React Hooks. Users can also add their own card with a term and definition to the current selected collection, or update the current card term and definition.

Built With

• React.js
• JavaScript
• Django Rest Framework
• Python
• MySQL
• HTML
• CSS
• Bootstrap
• Axios
• 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.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/Schmidt1519/flashcard-react.git

2. Install NPM packages

   npm install bootstrap axios 

Roadmap

• Only Show definition with mouse hover
• Update the layout/spacing to more resemble my original wireframe
• Improve the styling!

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

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

Acknowledgements

• devCodeCamp instructors
• My family