Skip to content

Latest commit

 

History

History
88 lines (60 loc) · 2.62 KB

readme.md

File metadata and controls

88 lines (60 loc) · 2.62 KB
Raw

PlanUp

Web Application where teachers can share and like/dislike lesson plans similar in spirit to Reddit Live demo here.

Table of Contents

General Information

  • What problem does it (intend to) solve?
  • Need for a secure web application to share teaching knowledge and lesson plans with other teachers
  • What is the purpose of your project?
  • To create a secure web application where teachers can share knowledge and lesson plans with fellow teachers

Technologies Used

  • Flask - version 3.0.1
  • Flask SQLAlchemy - version 3.1.1
  • HTML - version 5.0
  • Bootstrap - version 5.3
  • VSCode, Git and GitHub

Features

  • Sign In: users can sign in to their existing account
  • Sign Up: users can sign up and create an account
  • Awesome feature 3 comming soon

Setup

What are the project requirements/dependencies? Where are they listed? A requirements.txt or a Pipfile.lock file perhaps? Where is it located?

  • To start create a new folder and navigate to the folder you created
  • Create a virtual environment by running python3 -m venv venv in your terminal, for Windows omit the 3
  • Naivagte to your virtual environment to activtate using source venv/bin/activate for Mac

Note the virtual environment is recommended to avoid conflicts with global Python

  • After activating the virtual environment install the dependencies needed using pip or pip3 for Mac
  • Start coding your project just remember to activate and deactivate your virtual environment

Usage

How does one go about using it? User can navigate to landing page and see options to Sign Up/Login or go to another web page User can sign up and create an account User can login into their existing account User can see mulitple posts and different lesson plans

Project Status

Project is: in progress

Room for Improvement

Room for improvement:

  • Improvement to be done 1
  • Improvement to be done 2

To do:

  • Feature to be added 1
  • Feature to be added 2

Acknowledgements

  • This project was inspired by Reddit

DevTeam

Created by @el634dev Created by @b3fr4nk