/math-flash-cards

Django project

Primary LanguagePythonMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

math-flash-card

A simple Django application demonstrating basic math functions
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

Product Name Screen Shot

A quick Django project demonstrating the basic math functions of addition, subtraction, multiplication, and division.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

(back to top)

Getting Started

Getting Started

To Start a new Django app perform the following steps

  1. Install the latest version of Python, as of this writing version 3.11.1 was installed and used to code this project.

  2. Create a top-level folder to hold your project.

  3. Change into that directory. Once in the directory create a new python virtual environment with the following command:

    python3 -m venv venv
source venv/bin/activate

  4. At a minimum you will need Django and openai

    pip install Django openai

  5. Use the command to start the django project

    django-admin startproject codebot .

  6. Use the command to start a new django app

    python manage.py startapp website

  7. Register the app in settings.py

  8. Run the django project using the command

    python manage.py runserver

Installation

If you want to skip the steps above you can go ahead and clone this repo, and use my code as a starter.

  1. Clone the repo

    git clone https://github.com/drobb2020/codebot.git

  2. Install the required packages

    pip install -r requirements.txt

(back to top)

Usage

Add, subtract, multiply, or divide the two numbers show on the screen. Click submit and see if you got the answer right.

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

(back to top)

License

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

(back to top)

Contact

Your Name - @davidrobb2 - drobb2011@gmail.com

Project Link: https://github.com/drobb2020/math-flash-cards

(back to top)

Acknowledgments

I want to thank John Elder of Codemy.com for creating this course. Check out all of his courses at codemy.com.

(back to top)