Project- Favicon-Gen-Team-61
In this project, We are required to create a website that generates favicon, We have research on how this project will be done and how it will be implemented. We practiced using Figma, for the design HTML, CSS, JavaScript, and Python methods for development.
Runing Project Locally
This project is build using Django Templating
The Project location can be found in the src directory of the Backend folder
The project name is favicon_gen with one app called generator
Important things needed to run this project locally
Database: mysqlite3 (default django database)
.env file which contains ALL OUR SECRET KEYS below | SECRET_KEY="i#my$(ecbju!m4q3(*e=vb(^fy^)r9@t^p1lvq+jtk3rodbwxh" EMAIL_HOST_USER = 'your own email' EMAIL_HOST_PASSWORD='your email password' SOCIAL_AUTH_GOOGLE_OAUTH2_KEY='590907092652-ql58umhte7u9nqn6bavjqb5ekvpm9vmc.apps.googleusercontent.com' SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET='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'
-
clone the project main branch of this repo
-
go to the backend folder and create a virtual environment
-
After that activate the virtual env.
-
cd into the src folder and run this command to install all the packages
pip install -r requirements.txt -
run the server
Our Work:
Links to research documentation used in this project:
| Links | Applications |
|---|---|
| General Research | Google Doc |
| Research Plan | Google Doc |
| Figma Board(Sketches/Design process and Wireframes | Figma |
| Code/Database Schema | Google Doc |
| Documentation | Google Doc |
| Tasks Assigned | Google Doc |
| First Presentation Slides | Google Drive |
To-do list for frontend dev: Fork the repo and save a copy to your personal repo and them clone it to your local machine. Thereafter, open up a new terminal in the project directory and #Run: npm run dev to be sure that everything is working fine. Make changes and create a new branch develop. Commit changes and make pull requests and push. Open your github account, find the project and compere for a pull.
hint: You should see a message of this format:: Server running at http://localhost:51215 ✨ Built in 669ms after running npm run dev on the terminal.
This will be a proof that everything is working well
Author's :page_with_curl:
Acknowledgements :pray:
All work contained in this project was completed as part of the curriculum for Zuri Training in Partnership with Ingresive For Good. Zuri Training is an online program that prepares students for careers in the tech industry using project-based peer learning. For more information, visit this link.
