https://github.com/blacksmithop/knowledgerepo

A repo with a collection of useful resources
https://github.com/blacksmithop/knowledgerepo

hacktoberfest

Last synced: 3 months ago
JSON representation

A repo with a collection of useful resources

• Host: GitHub
• URL: https://github.com/blacksmithop/knowledgerepo
• Owner: blacksmithop
• Created: 2024-10-14T08:55:25.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-10-24T10:27:43.000Z (3 months ago)
• Last Synced: 2024-10-24T22:13:29.628Z (3 months ago)
• Topics: hacktoberfest
• Language: JavaScript
• Homepage: https://knowledge.abhinavkm.com/
• Size: 71.3 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
# Knowledge Repository

![Python](https://img.shields.io/badge/Python-FFD43B?style=for-the-badge&logo=python&logoColor=blue)

![Docker](https://img.shields.io/badge/Docker-2CA5E0?style=for-the-badge&logo=docker&logoColor=white)

**Knowledge Repository** is a platform to organize and share useful information.

## Planned Features

- **Knowledge Base**: Keep your knowledge in one place

- **Search**: Find information quickly.

- **Docker Support**: Deploy with docker

## Getting Started

### Prerequisites

- **Python 3.9+**

- **Docker**

### Installation

1. **Clone the Repository**

   ```bash

   git clone https://github.com/yourusername/KnowledgeRepo.git

   cd KnowledgeRepo

   ```

2. **Install Dependencies**

   ```bash

   pip install -r requirements.txt

   ```

3. **Run the Application**

   ```bash

   uvicorn app.main:app --reload

   ```

   The app will be available at [http://localhost:8000](http://localhost:8000).

### Running with Docker

1. **Build the Docker Image**

   ```bash

   docker build -t knowledge-repo .

   ```

2. **Run the Docker Container**

   ```bash

   docker run -p 8000:8000 knowledge-repo

   ```

## Usage

- Access the main page at [http://localhost:8000](http://localhost:8000).

## Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.