Code Monkey home page Code Monkey logo

flask-blog's Introduction

Flask Blog

IP for MC18 week 4 of Python that requires creating a personal blogging website where you can create and share your opinions and other users can read and comment on them. Additionally, add a feature that displays random quotes to inspire your users.

By Philip Kariuki

Description

This is a Flask web application that entails creating a blogging website where you can create and share your opinions and other users can read and comment on them. Additionally, it has a feature that displays random quotes to inspire users.

Live link : https://phillblog.herokuapp.com

User Stories

  • As a user, I would like to view the blog posts on the site.
  • As a user, I would like to comment on blog posts.
  • As a user, I would like to view the most recent posts.
  • As a user, I would like to an email alert when a new post is made by joining a subscription.
  • As a user, I would like to see random quotes on the site.
  • As a writer, I would like to sign in to the blog.
  • As a writer, I would also like to create a blog from the application.
  • As a writer, I would like to delete comments that I find insulting or degrading.
  • As a writer, I would like to update or delete blogs I have created.

Specifications

Behaviour Input Output
Display posted posts N/A List of posts show up on the home page
See an entire post Click on a post's title Directed to a page with the post's title and comments on the post
Comment on a post Click Comment Registered user is directed to a page with a form where the user can create and submit a comment on a post
Delete a comment Click delete for the specific comment An authenticated user with a writer's role deletes a comment
User registration Click Sign Up New user registers with an available name and email and gets confirmation email
User login Click Sign In Registered user is signs in and is able to access profile menu

Setup/Installation Requirements

To clone this repo, open terminal in your desired folder then run:

    $ git clone https://github.com/philipkariuki/flask-blog/
    $ cd /flask-blog

To create and activate the virtual environment and install pip:

    $ python3.6 -m venv --without-pip virtual
    $ source virtual/bin/env
    $ curl https://bootstrap.pypa.io/get-pip.py | python

To install all the required pip modules for proper functionality:

    (virtual)$ python3.6 -m pip install -r requirements.txt

To run the application, in your terminal:

    $ chmod +x start.sh
    $ ./start.sh

Alternatively:

    $ python3.6 manage.py server

To run unittests:

    $ python3.6 manage.py test

Known Bugs

No known bugs

Technologies Used

  • HTML
  • CSS
  • Python3.6
  • Pip
  • Flask
  • Bootstrap
  • Postgres Database
  • gunicorn

Contributors

philipkariuki

Support and contact details

To support me, you can contact me at [email protected]

License

MIT © 2019

flask-blog's People

Contributors

philipkariuki avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.