This project is being developed by Team 64 of Zuri Training Organization and is aimed at building a web application for favicon generation.
The main feature is the Favicon Converter which will allow users to upload an image and have it converted to a favicon. The web app also has two other favicon generating features: Favicon Generator and Texticons.
Information given: Name, GitHub username, and period of collaboration.
http://zuricongen.pythonanywhere.com/This file is designed to provide overview, setup instructions and background details of this project.
Members of the development team are assigned to ensure that this file is always up-to-date, and can be followed through conveniently.
Note : Developers must include new dependencies in the requirements.txt file and ensure they are updated in the main branch.
Client-Side Scripting / Coding
HTML (HyperText Markup Language)
CSS (Cascading Style Sheets)
JavaScript
Server-Side Scripting / Coding
Django with Python
As mentioned earlier , this is a Django project.
Please, take note of the operating system you are using as the steps may vary.
This set-up instructions aims at helping a developer get the code from the git repository to run on their system, for possibly further development.
Follow these steps to fetch the git code to your system:
Clone this project's repository.
To do this, open your code editor and choose "Clone Git Repository", then click on "Clone from GitHub", and enter https://github.com/zuri-training/Team-64_Favicon-Gen.git
As at the time of writing this set-up instructions, the branch used for development is : main
The project dependencies are contained in the requirements.txt file in the main branch.
Run these commands in your command line:
pip
pip install virtualenv
virtualenv envname
envname\scripts\activate
pip install -r requirements.txtThe project directory is titled 'website', so run this in your command line:
cd websiteThe collaborators' worked following this guide: https://github.com/zuri-training/Team-64_Favicon-Gen/blob/main/Collaborators'-Guide.md
This project runs on Python 3.8.13 as found in the runtime.txt file here: https://github.com/zuri-training/Team-64_Favicon-Gen/blob/main/runtime.txt
This web application, ZuriconGen, is deployed on the pythonanywhere.com server. The login credentials can be obtained from the team lead, SerahN. She can be contacted via seraho.nwoke@gmail.com
Hello future dev, comments are made throughout the codes for easy understanding. Study these well and follow the set-up instructions.
The (User Experience Design) Research documentation can be found here: https://docs.google.com/document/d/1lJeFEHFBVzyME7ht9RB-mifZzaeGIxM-HAnsudWQUds/edit?usp=sharing
Design research elements like participant note, pain points, empathy map, user flow, information architecture and idea prioritization can be found here: https://www.figma.com/file/2P8rcupisqFHMPfaX5TeDl/Team-64_Favicon_gen?node-id=95%3A713
The wireframes and designs for this project can be found on the team's figma board here:
https://www.figma.com/file/Q6kNdChpgQzLfjIKwSl2Ok/Team-64_Favicon_gen?node-id=50%3A2
The database schema for this project can be found here: https://drive.google.com/file/d/1HiMyBAbYz_H4sFE8chP49i1qXhE_sC2g/view?usp=sharing
The workflow documentation for this project can be found here: https://drive.google.com/file/d/1ewR4YWZk7R6iItfuXfh_NQAaed1TBK31/view?usp=sharing