FieldScribe Pro is a Flask-based web application designed for journal entry management. It provides user authentication, admin functionality, and a dashboard for managing journal entries.
- User registration and authentication
- Admin user management
- Journal entry creation, reading, updating, and deletion
- Dashboard for viewing and managing entries
- Responsive design using Tailwind CSS
Before you begin, ensure you have met the following requirements:
- Python 3.7+
- PostgreSQL database
- pip (Python package manager)
- Clone the repository:
git clone https://github.com/yourusername/fieldscribe-pro.gitcd fieldscribe-pro
- Set up a virtual environment:
python -m venv venvsource venv/bin/activate
On Windows use
venv\Scripts\activate
- Install the required packages:
pip install -r requirements.txt
- Set up environment variables:
Create a
.envfile in the root directory and add the following:
SECRET_KEY=your_secret_keyDATABASE_URL=postgresql://username:password@localhost/database_name
Replace your_secret_key, username, password, and database_name with your actual values.
- Initialize the database:
flask db initflask db migrate -m "Initial migration"flask db upgrade
To run the application:
-
Ensure you're in the project directory and your virtual environment is activated.
-
Set the Flask application:
export FLASK_APP=main.pyset FLASK_APP=main.py
-
Run the application:
flask run --host=0.0.0.0 --port=5000
-
Open a web browser and navigate to
http://localhost:5000
To contribute to FieldScribe Pro, follow these steps:
- Fork the repository
- Create a new branch:
git checkout -b <branch_name> - Make your changes and commit them:
git commit -m '<commit_message>' - Push to the original branch:
git push origin <project_name>/<location> - Create the pull request
Alternatively, see the GitHub documentation on creating a pull request.
If you want to contact the maintainer, you can reach out at your-email@example.com.
This project uses the following license: MIT License.