diff --git a/README.md b/README.md index 8ea7e62..7f0a32e 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A transaction management system. -Last updated: Thu Jul 3 13:16:40 EDT 2025 +Current version: 0.1.2 ## Development @@ -29,12 +29,6 @@ For production deployment, use the production stack configuration: docker stack deploy -c stack.production.yml ploughshares ``` -Make sure to create the required Docker secrets first: - -```bash -echo "your-secure-password" | docker secret create db_password - -``` - ### Staging For staging deployment, use the staging stack configuration: @@ -43,12 +37,6 @@ For staging deployment, use the staging stack configuration: docker stack deploy -c stack.staging.yml ploughshares-staging ``` -Make sure to create the required Docker secrets first: - -```bash -echo "your-staging-password" | docker secret create db_password_staging - -``` - ## CI/CD This project uses Woodpecker CI for continuous integration and deployment. The pipeline: @@ -56,7 +44,6 @@ This project uses Woodpecker CI for continuous integration and deployment. The p 1. Builds the Docker image for multiple architectures 2. Pushes the image to the registry 3. Deploys to the production environment -4. Sends a notification about the deployment status ## Configuration Files @@ -70,13 +57,6 @@ This project uses Woodpecker CI for continuous integration and deployment. The p The application uses PostgreSQL for data storage. The database schema is automatically initialized using the `schema.sql` file. -To generate test data, use the script in the tests directory: - -```bash -# Inside the Docker container -python tests/generate_test_data.py --count 20 -``` - ## API The application provides a RESTful API for managing transactions. See the API documentation at `/api-docs` when the application is running. @@ -151,10 +131,6 @@ Run tests with: python3 -m pytest tests/ ``` -### Pre-commit Hooks - -Git pre-commit hooks automatically run tests before allowing commits, ensuring code quality is maintained. - ## Docker Setup The application is containerized using Docker and can be run using docker-compose. @@ -200,37 +176,10 @@ This will: docker-compose down ``` -### Running Locally - -1. Start PostgreSQL: -```bash -./start_postgres.sh -``` - -2. Initialize the database: -```bash -python init_db.py -``` - -3. Start the application: -```bash -python app.py -``` - ## API Documentation API documentation is available at: - http://localhost:5001/api-docs -- http://localhost:5001/api/docs -- http://localhost:5001/docs - -## Testing - -To generate test data: - -```bash -python generate_test_data.py -``` ## Accessing the Application