Giter Club home page Giter Club logo

code-log's Introduction

Code-Log

Ed-Tech

User Story: Code-Log

As a software developer

I want to publish a code snippet on Code-Log

So that I can share my code with the community and receive feedback on it.

Acceptance Criteria:

  1. Upon logging in, I am directed to my dashboard.
  2. On my dashboard, I can initiate the creation of a new code snippet.
  3. I can enter a title, description, and code for the snippet and preview its appearance.
  4. After reviewing, I can publish the code snippet.
  5. Published snippets are visible with proper formatting and syntax highlighting.
  6. Other users can leave comments or submit debugging solutions for my snippet.
  7. My dashboard lists published snippets with titles, descriptions, and comment/debugging solution counts.
  8. I can edit the title, description, and code of a published snippet.
  9. I can remove a published snippet after confirming the deletion.
  10. An embed code is provided for each snippet, allowing me to share it on external websites or blogs.

Overview

Flask web application.

Table of Contents

Getting Started

  1. Installation

  2. Clone the repository

git clone https://github.com/erokemwa/Code-Log/
  1. Navigate to the project directory
cd Code-Log
  1. Install dependencies
pip install -r requirements.txt

code-log's People

Contributors

erokemwa avatar

Stargazers

Adewole Conde avatar Hajar Lamharchi avatar

Watchers

 avatar

code-log's Issues

Templates with Jinja2: Integrating HTML templates in Flask

Overview:

This issue focuses on using Jinja2 templating engine to render HTML templates in Flask.

Tasks:

  • Learn Jinja2 templating syntax.
  • Create a simple HTML template.
  • Integrate the template with a Flask route.
  • Pass dynamic data to the template.

Additional Notes:

Feel free to ask questions and seek clarification on any of the tasks.

Create a Flask Server ๐ŸŒ

You'll have to initiate the Backend for the application.

Create a folder in the Root directory named Code-Log
Create a codelog.py file inside it
Import and install required dependencies for creating the Flask Server
Create / route for the application.
Make sure that Flask App Runs in the Flask Server upon starting it.
Don't forget to add requirements.txt file in the Code-Log directory.

Static Files: Serving CSS, JavaScript, and Images in Flask

Overview:

This issue covers the serving of static files such as CSS, JavaScript, and images in Flask.

Tasks:

  • Set up a static folder in your Flask project.
  • Include and use static files in your templates.
  • Test the application to ensure static files are served correctly.

Additional Notes:

Feel free to ask questions and seek clarification on any of the tasks.

Request Handling: Processing User Input in Flask

Overview:

This issue delves into handling user input and requests in Flask.

Tasks:

  • Understand the concept of HTTP methods (GET, POST).
  • Access request data using the request object.
  • Implement form handling in Flask.
  • Validate and process form data.

Additional Notes:

Feel free to ask questions and seek clarification on any of the tasks.

Middleware: Understanding and Implementing in Flask

Overview:

This issue explores the concept of middleware in Flask.

Tasks:

  • Learn how middleware functions work in Flask.
  • Implement a simple middleware function.
  • Test the middleware in the Flask application.

Additional Notes:

Feel free to ask questions and seek clarification on any of the tasks.

Learning Flask Basics: Introduction and Routing

Overview:

This issue covers the foundational concepts of Flask, including routing.

Tasks:

  • Understand Flask application structure.
  • Explore basic routing using decorators.
  • Create routes for different URLs.
  • Test the routes with the development server.

Additional Notes:

Feel free to ask questions and seek clarification on any of the tasks.

Explore Flask Extensions: Forms, Databases (SQLAlchemy), and Authentication

Overview:

This issue involves exploring Flask extensions to enhance your application.

Tasks:

  • Research and install Flask-WTF for form handling.
  • Integrate Flask-SQLAlchemy for database interactions.
  • Implement user authentication using Flask-Login.
  • Test and ensure each extension is working correctly.

Additional Notes:

Feel free to ask questions and seek clarification on any of the tasks.

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.