Skip to content

Notrix-tech/CRUD-Py

Repository files navigation

Here is a basic README.md for the CRUD-Py project:

# CRUD-Py

## Overview

CRUD-Py is a Flask-based web application that implements basic CRUD (Create, Read, Update, Delete) operations. This project is designed to demonstrate how to build a simple CRUD application using Python and Flask.

## Features

- User authentication and authorization
- Admin dashboard
- Basic CRUD operations

## Requirements

- Python 3.x
- Flask
- Flask-SQLAlchemy
- Flask-Login
- Flask-Mail

## Installation

1. Clone the repository:
    ```sh
    git clone https://github.com/Clairtonlm/CRUD-Py.git
    cd CRUD-Py
    ```

2. Create a virtual environment and activate it:
    ```sh
    python3 -m venv venv
    source venv/bin/activate
    ```

3. Install the dependencies:
    ```sh
    pip install -r requirements.txt
    ```

## Usage

1. Set up the configuration in `config.py`.

2. Run the application:
    ```sh
    python app.py
    ```

3. Open your browser and go to `http://127.0.0.1:5000/`.

## Project Structure

- `app.py`: The main application file that initializes and runs the Flask application.
- `models.py`: Defines the database models.
- `auth/`: Contains the authentication blueprint.
- `admin/`: Contains the admin blueprint.
- `templates/`: Contains the HTML templates.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

You can save this content to the README.md file in your repository.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published