Skip to content

Syntax-Syndicate-Ltd/Project-Statement-Generator-Source-Code-

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

8 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“„ Project Statement Generator

A Flask-based web application that helps users quickly generate professional project statements. Includes authentication, project statement input, and formatted output.This project is powered by GROQ CLIENT API, and give AI analyzied responses.

πŸš€ Features

User Authentication β€” Register, log in, and securely manage your account.

Project Statement Creation β€” Enter details like objectives, type, and timeline.

Instant Results β€” Automatically generate and view your formatted project statement.

Quick Print Button - Instantly print your statement

Database Storage β€” SQLite database to store user data and project statements.

Responsive UI β€” HTML/CSS & Bootstrap, templates for a clean and mobile-friendly experience.

πŸ› οΈ Tech Stack

Backend: Python, Flask, SQLAlchemy

Frontend: HTML, CSS (Custom Styling), Bootstrap

Database: SQLite

Environment: .env for configuration

Api : Groq API

Authentication: Werkzeug security for password hashing

πŸ“‚ Project Structure

.
β”œβ”€β”€ app.py                  # Main Flask application
β”œβ”€β”€ requirements.txt        # Python dependencies
β”œβ”€β”€ .env                    # Environment variables
β”œβ”€β”€ instance/app.db         # SQLite database
β”œβ”€β”€ static/css/style.css    # Styling
β”œβ”€β”€ templates/              # HTML templates
β”‚   β”œβ”€β”€ base.html
β”‚   β”œβ”€β”€ index.html
β”‚   β”œβ”€β”€ login.html
β”‚   β”œβ”€β”€ register.html
β”‚   β”œβ”€β”€ result.html
└── Project-Statement-Generator/README.md  # Original README

βš™οΈ Installation

1. Clone the repository

git clone https://github.com/Syntax-Syndicate-Ltd/Project-Statement-Generator-Source-Code-.git
cd (your_path_here)

2.Create & activate a virtual environment

python -m venv venv
source venv/bin/activate      # On Mac/Linux
venv\Scripts\activate         # On Windows

3.Install dependencies

pip install -r requirements.txt

4.Set environment variables

Create a .env file with:

FLASK_APP=app.py
FLASK_ENV=development
SECRET_KEY=your-secret-key
GROQ_API_KEY=your-api-key

Follow these steps to get your API key (It's free don't worry !):

(I) Go to the official Groq Developer Portal: πŸ‘‰ https://console.groq.com/keys

(II) Sign up or log in with your account.

(III) Navigate to the API Keys section.

(IV) Click "Create New API Key" and copy it.

(V) Open your project folder and locate the .env file (create one if it doesn't exist).

(VI) Paste your key in the .env file like this:

GROQ_API_KEY=your-api-key-here(replace this with your api key)

Save the file β€” you’re done! πŸŽ‰

⚠ Important: Never share your API key publicly (e.g., on GitHub). Your .env file is already listed in .gitignore so it won’t be uploaded.

5.Run the app

python app.py

πŸ“Έ Screenshots

Example Use : image image image

About

This is the repository for the source code of the project statement generator.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published