favicon-gen-team-70's Introduction

favicon-gen-team-70

IconCity

This is a favicon generator platform built to relieve designers and developers of the hassle they face in getting favicons. Our Top priorities are to give users a wonderful UX and smooth favicon generation expeirience while offering other top notch features.

Build your favicons fast and easy!!!

favicon-gen-team-70

FAVICON GENERATOR by Zuri Project Team 70 ICONCITY

Iconcity is a favicon generator where an authenticated user can upload an image or type a text, generate and download favicons in all the standard sizes and formats and their respective HTML codes(parsed in a text file). Users can also save their favicons in their collections dashboard for future download.

User System Overview

For Unauthenticated Users:

Users can view documentation

Users can choose to register

Only authenticated users can access the generating engine

For Authenticated Users:

Users can upload an image or type text

Users can generate favicons of varying screen sizes

Users can save downloaded files

Users can choose to redownload a saved file

Architecture

Adopted the monolith architecture using Django templating

Folder Structure

home: App for unauthenticated users

dashboard: App for authenticated users

static: For assets and styling sheets

iconcity: contains project configuration

For Developers

Steps to deploy the Application

Step 1: Create a virtual environment (python -m venv )
Step 2: Activate your virtual environment (virtualEnvironmentName/Scripts/activate)
Step 3: Install the modules (pip install -r requirements.txt)
Step 4: Create a .env file and add a secret key
Step 5: Start the application command: python manage.py runserver. (Ensure you are in the same directory that has the manage.py file)
Step 6: If you encounter the ModuleNotFoundError: No module named 'decouple', Install the decouple module with the command (pip install python-decouple)
Step 7: Open link on your web browser