Pastry_Crust- Documentation

Pastry_crust is a minimal pastebin-type application inspired by Rust's sweetness, allowing users to quickly share code snippets and text content.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Usage
  • Running the Application
  • Accessing the Paste Webpage
  • Submitting a Paste
• Contributing
• Used Technologies and Dependencies
• License

Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

• Rust programming language (Recommended version: Install Rust)
• Cargo package manager (Usually comes with Rust installation)

Installation

1. Clone the repository:

   git clone https://github.com/lordofwizard/pastry_crust.git

2. Change into the project directory:

   cd pastry_crust

3. Build the project:

   cargo build

Usage

Running the Application

Run the application using Cargo:

cargo run

Accessing the Paste Webpage

Open your web browser and navigate to:

http://localhost:8080

You will be greeted with the Pastry_Crust webpage.

Submitting a Paste

1. Enter your code or text content in the textarea.
2. Click the "Submit" button.
3. You will be redirected to a page displaying your paste token.

Contributing

We welcome contributions! If you'd like to contribute to the project, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature/bugfix.
3. Make your changes and commit them.
4. Push your changes to your forked repository.
5. Create a pull request.

Used Technologies and Dependencies

This project is built using the Rust programming language. It utilizes the following Rust crates:

• actix-web
• rusqlite
• rand
• actix-files
• serde

The project also incorporates Tailwind CSS for styling.

License

This project is licensed under the MIT License.

---