Thoughts App

Description

Thoughts App is a web-based platform designed to capture and share user thoughts. It provides an intuitive interface for users to post, edit, and manage their thoughts over time. This application is built using Python, Docker, and PostgreSQL, featuring a robust API and a responsive front-end.

Features

Post thoughts with a title and content
Edit existing thoughts
List all thoughts in a timeline
Dockerized environment for easy setup and deployment

Technology Stack

Back-end: Python with FastAPI
Database: PostgreSQL
Containerization: Docker and Docker Compose
Monitoring: Prometheus

Getting Started

Prerequisites

Docker
Docker Compose
git (optional, for cloning the repository)

Installation

Clone the Repository (Optional)

git clone https://github.com/artgas1/thoughts_app_diploma.git
cd thoughts_app_diploma

Set Up the Environment

# Install Docker and Docker Compose if not already installed
./install_docker.sh

# Set up the PostgreSQL database volume
./clear_postgres_volume.sh

Run the Application
```
docker-compose up -d
```

Accessing the Application

The web interface can be accessed at http://localhost:8000
API documentation is available at http://localhost:8000/docs

Development

Building the Application

To build the Docker container manually:
```
docker-compose build
```

Running Tests

Execute tests by running:

docker-compose run --rm web python thoughts_app/manage.py test thoughts_core thoughts_app

Configuration

Docker configurations: Adjust docker-compose.yml for Docker settings.
Prometheus monitoring: Modify prometheus.yml to configure monitoring settings.

Setting Up Secrets in GitHub

Before you begin working with CI/CD, you need to set up secrets in your GitHub repository to ensure security and environment configuration. Follow these steps:

Go to your repository on GitHub. Find the "Settings" section, then go to "Secrets" and select "Actions". Add the following secrets that will be used in your CI/CD process:

DJANGO_SECRET_KEY: The secret key for your Django application.
DJANGO_DEBUG: Debug parameter (true or false).
DJANGO_ALLOWED_HOSTS: Allowed hosts.
DB_HOST, DB_NAME, DB_USER, DB_PASSWORD, DB_PORT: Parameters for database connection.
OPENAI_API_KEY: API key for OpenAI services, if used.
SERVER_IP: IP address of your server.
SERVER_USER: Username for SSH access.
SERVER_SSH_PRIVATE_KEY: Private SSH key for server access.

Contributing

Contributions to the Thoughts App are welcome! Please refer to the contributing guidelines for more details.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

Thanks to everyone who has contributed to this project!!!

artgas1 / thoughts_app_diploma Goto Github PK

thoughts_app_diploma's Introduction