Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/el634dev/codezen

Platform to help educators organize their materials
https://github.com/el634dev/codezen

docker flask html-bootstrap

Last synced: 20 days ago
JSON representation

Platform to help educators organize their materials

Host: GitHub
URL: https://github.com/el634dev/codezen
Owner: el634dev
License: apache-2.0
Created: 2023-11-22T20:14:06.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-11-07T22:13:13.000Z (about 2 months ago)
Last Synced: 2024-11-07T23:23:22.600Z (about 2 months ago)
Topics: docker, flask, html-bootstrap
Language: HTML
Homepage:
Size: 694 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        # CodeZen

> Platform to help educators organize their materials

> 

> No live demo yet. 

## Table of Contents

* [General Info](#general-information)

* [Technologies Used](#technologies-used)

* [Features](#features)

* [Installation](#installation)

* [Usage](#usage)

* [Project Status](#project-status)

* [Docker Command References](#docker-commands)

## General Information

- This project is intented to be a platform to upload educational materials

## Important

-  When trying to host your own project use Python Anywhere or Aptible

-  When using a virtual environment make sure to activate and deactive your environment, creating one helps avoid conflicts with the global interpreter/environment

## 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)

![Bootstrap](https://img.shields.io/badge/bootstrap-%238511FA.svg?style=for-the-badge&logo=bootstrap&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 navigate through mulitple web pages

- Users can sign up ( In-Progress)

- Users can create an account ( In-Progress)

## Installation

See the appropriate guide for your environment and operating system.

- Flask or older Flask version

- Other frameworks that are not Flask, Bootstrap or a templating engine that is different from Jinja

>

  a. Flask Installation

>

  Add Flask to your global or virutal 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. Boostrap Installation

>

  Add the link provided by Boostrap in your header located in your HTML file (this could also be your base file).

  >

  ``

  >

  - Make sure to use version 5 as this is the latest version

>

  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.

## Usage

How does one go about using it?

`User navigates onto the home page and can click any buttons or use the navigation links in the header(top of the page) or footer(bottom of the page).`

>

`User can also view the website on mulitple devices such as desktop or mobile.`

## Project Status

Project is: _in progress_ 

## Docker Commands

1. Build the Image

`docker build -t flask-image .`

2. Run the Container

`docker run -p 5001:5000 --rm --name flask-container flask-image`

3. Access via Browser

`http://localhost:5001`