Team-65-Favicon-gen

A web app that generates favicon of different sizes for different use cases for users

A platform that allows users to generate favicons – both icon and related codes to embed. Platform in the sense that it can be a web application (web app) or a website. Users or companies can visit this platform to generate their favicons

Tech Stack

• Backend
  • Django(framework)
  • Postgres(DBMS)
  • Cloudinary(Image storage)
• Frontend
  • HTML
  • CSS
  • javascript

To run the app locally on you computer, follow the following instructions:

1. Using Postrges, create a database with the Username, Database name, Password and Port included in the .env file
2. Clone the repository's main branch to your local machine
3. Inside the folder of your local clone, open a terminal and create a virtual environment by running virtualenv .venv
4. Next pip install all the requirements by running pip install -r requirements.txt
5. Make all the server migrations by running python3 manage.py makemigrations
6. Migrate the changes to the database and build the database tables by running python3 manage.py migrate
7. Finally run the server by running python3 manage.py runserver

_Any error encounted during the above process should be reported to this email: [email protected]

How Iconator Works

Iconator takes an image, either jpeg, png ......., and creates a folder containing png and ico favicons as well as html code to be used with your website

To view the Iconator website, use this link

The following is required from every user before you can access the features of Iconator

1. Username
2. Email
3. Password
4. First name
5. Last name

Click Signup to signup on the platform and Signin to login if you already have an account

The complete documentation of the project can be found at in google doc

Repository Tree Structure

├── README.md
├── accounts
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── migrations
│   ├── models.py
│   ├── tests.py
│   ├── urls.py
│   └── views.py
├── core
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── engine.py
│   ├── migrations
│   ├── models.py
│   ├── site.webmanifest
│   ├── tests.py
│   ├── urls.py
│   └── views.py
├── favicon_gen
│   ├── __init__.py
│   ├── accounts
│   ├── asgi.py
│   ├── core
│   ├── favicon_gen
│   ├── frontend
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
├── local
│   ├── bin
│   ├── lib
│   └── pyvenv.cfg
├── manage.py
├── my_file.py
├── requirements.txt
├── static
│   ├── css
│   ├── images
│   └── js
└── templates
    ├── accounts
    ├── base.html
    ├── core
    ├── footer.html
    └── navbar.html

The more detailed structure can be found here