Cutit Documentation

Cutit Project Documentation

This documentation provides an overview and step-by-step guide for the cutit project, a full-stack web application developed using Flask, HTML, CSS, JavaScript, and Bootstrap. cutit is a web-based tool for managing and organizing your url collection.

Table of Contents

1. Introduction
2. Features
3. Technologies Used
4. Installation and Setup
5. Usage
6. Project Structure
7. Contributing
8. License

Introduction

The cutit project is a web application designed to help users manage their url collection. It provides features for adding, editing, and organizing url, as well as customizing url based on brand needs.

Features

The cutit project includes the following key features:

• User registration and authentication
• URL creation, editing, and deletion
• Analytics
• QR code generation
• User-friendly interface with responsive design using Bootstrap

Technologies Used

Cutit is built using the following technologies and frameworks:

• Flask: Backend development and server-side logic
• HTML: Markup language for structuring web pages
• CSS: Styling and presentation of web pages
• JavaScript: Client-side scripting for interactivity
• Bootstrap: Front-end framework for responsive design and styling

Installation and Setup

To install and set up the cutit project on your local development environment, follow these steps:

1. Clone the repository:

   git clone https://github.com/Jessica-ovabor/JessiScissor.git
   

2. Navigate to the project directory:

   cd JessiScissor
   

3. Create and activate a virtual environment (optional but recommended):

   python3 -m venv venv
   source venv/bin/activate
   

4. Install the required dependencies:

   pip install -r requirement.txt
   

5. Set up the database:

   python manage.py db init
   python manage.py db migrate
   python manage.py db upgrade
   

6. Start the development server:

   python manage.py runserver
   

7. Open a web browser and visit http://localhost:5000 to access the cutit application.

Usage

Once the Cutit application is set up and running, you can perform the following actions:

• Register a new user account or log in with an existing account.
• Add new URL to your collection by providing the necessary details.
• Edit or delete existing URL from your collection.
• Track the number of visit or clicks.
• Generate QR code.
• Navigate through the user-friendly interface to manage your URL collection efficiently.

Project Structure

The Cutit project follows a common project structure for a Python-based web application. The main components and directories include:

• app: Contains the application logic and routes.
• static: Holds static files such as CSS, JavaScript, and images.
• templates: Contains HTML templates for rendering web pages.
• migrations: Manages database migrations using Flask-Migrate.
• settings.py: Configuration file for the application.
• requirement.txt: Lists the required Python dependencies.

Contributing

Contributions to the cutit project are welcome. If you would like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and ensure they adhere to the

project's coding style and guidelines. 4. Commit your changes and push them to your forked repository. 5. Submit a pull request to the main repository, explaining your changes and the rationale behind them.

License

The Cutit project is licensed under the MIT License. Feel free to modify and distribute the project as per the terms of the license.