Plainpad

<h1 align="center">
    <br>
    <a href="https://plainpad.org">
        <img src="https://raw.githubusercontent.com/alextselegidis/plainpad/master/logo.png" alt="Plainpad" width="200">
    </a>
    <br>
    Plainpad
    <br>
</h1>

<h4 align="center">
    Plainpad is a self-hosted note taking application.
</h4>

<h4 align="center">
    <a href="https://plainpad.org</a>
</h4>

<p align="center">
  <a href="#">
    <img src="https://img.shields.io/github/license/alextselegidis/plainpad?style=for-the-badge" />
  </a>
  <a href="#">
    <img src="https://img.shields.io/github/v/release/alextselegidis/plainpad?style=for-the-badge" />
  </a>
  <a href="#">
    <img src="https://img.shields.io/github/downloads/alextselegidis/plainpad/total?style=for-the-badge" />
  </a>
</p>

<p align="center">
  <a href="#about">About</a> •
  <a href="#setup">Setup</a> •
  <a href="#license">License</a>
</p>

![screenshot](screenshot.png)

## About

Driven by simplicity and stability in mind, Plainpad offers great potential at no cost. Become the owner of 
your data as Plainpad will nicely run on your own server. 

## Setup

To clone and run this application, you'll need Docker installed on your computer. From your command line:

```bash
# Clone this repository
$ git clone https://github.com/alextselegidis/plainpad.git

# Go into the repository
$ cd plainpad

# Start Docker 
$ docker compose up -d
```

Note: the current setup works with Windows and WSL & Docker.

## Demo Data

A standalone seeder is available to populate the database with realistic
sample notes (medical-student study notes). It is **not** wired into the
default `DatabaseSeeder` and must be run manually:

```bash
# From the server directory (or inside the app container)
$ php artisan db:seed --class=DemoSeeder
```

The seeder creates a dedicated demo user the first time it runs:

- Email: `med.student@example.org`
- Password: `12345678`

Re-running the command refreshes the demo user's notes without producing
duplicates.

## License 

Code Licensed Under [GPL v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html) | Content Under [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/)

---

Website [alextselegidis.com](https://alextselegidis.com) &nbsp;&middot;&nbsp;
GitHub [alextselegidis](https://github.com/alextselegidis) &nbsp;&middot;&nbsp;
Twitter [@alextselegidis](https://twitter.com/AlexTselegidis)

###### More Projects On Github
###### ⇾ [Easy!Appointments &middot; Open Source Appointment Scheduler](https://github.com/alextselegidis/easyappointments)
###### ⇾ [Questionful &middot; Web Questionnaires Made Easy](https://github.com/alextselegidis/questionful)
###### ⇾ [Integravy &middot; Service Orchestration At Your Fingertips](https://github.com/alextselegidis/integravy)