https://github.com/el634dev/todo-list

https://github.com/el634dev/todo-list

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/el634dev/todo-list
• Owner: el634dev
• Created: 2023-12-05T22:38:55.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-05T22:47:17.000Z (over 2 years ago)
• Last Synced: 2025-01-30T10:30:30.890Z (over 1 year ago)
• Language: HTML
• Size: 6.84 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Todo-List

> Created a todo list using Flask

> 

> No live demo. 

## Table of Contents

* [General Info](#general-information)

* [Technologies Used](#technologies-used)

* [Features](#features)

* [Installation](#installation)

* [Usage](#usage)

* [Project Status](#project-status)

## General Information

- Project is built using Jinja2, MongoDB and Flask

- The purpose of this project is to practice with Flask and MongoDB

## Important

-  When creating you database use a virtual environment to avoid conflicts with the global interpreter

-  When using a virtual environment make sure to activate and deactive your environment inside of your folder where the environment is created

## Technologies Used

- ![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)

- ![CSS3](https://img.shields.io/badge/css3-%231572B6.svg?style=for-the-badge&logo=css3&logoColor=white)

- ![MongoDB](https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white)

- ![Flask](https://img.shields.io/badge/flask-%23000.svg?style=for-the-badge&logo=flask&logoColor=white)

- ![Jinja](https://img.shields.io/badge/jinja-white.svg?style=for-the-badge&logo=jinja&logoColor=black)

## Features

List of features here:

- Users can add todos

- Users can remove todos

- Users can update todos

## Installation

See the appropriate guide for your environment and operating system.

- Flask or older Flask version

- Other frameworks that are not Flask, Bootstrap, Jinja2

>

  a. Flask Installation

>

  Add Flask to your global or virtual enivorment:

  For macOS:

  `pip3 install flask`

  For Windows:

  `pip install flask`

- Make sure that Flask is the current version

- If using the virtual enivorment make sure to navigate to your folder that you create your env folder and activated your env

- You can activate your enivorment by typing `source\bin\activate\` and for Windows `.\env\Scripts\activate`

>

  b. MongoDB

>

  Create a new database and follow the steps. Make sure to set the language to the one you are using for Flask it's Python. 

  >

  After creating a new database go to the database tab in the sidemenu and create a new collection. After just connect your database with the provided code.

  >

>

  c. Jinja/HTML/CSS Installation

>

  - There is no installation needed for Jinja, HTML, CSS.

>

  HTML and CSS is built into VSCode, while Jinja is Flask's official templating engine just start with {{}} or {%%}.

## Usage

How does one go about using it?

`User navigates onto the home page and can add, remove, update and delete todo items.`

## Project Status

Project is: _complete_