https://github.com/michael-obele/libernotarum

A web application for storing and utilizing Markdown for various purposes. Built with Svelte and SvelteKit, focusing on efficiency and modern web standards.
https://github.com/michael-obele/libernotarum

Last synced: 22 days ago
JSON representation

A web application for storing and utilizing Markdown for various purposes. Built with Svelte and SvelteKit, focusing on efficiency and modern web standards.

• Host: GitHub
• URL: https://github.com/michael-obele/libernotarum
• Owner: Michael-Obele
• License: gpl-3.0
• Created: 2024-06-21T17:50:33.000Z (5 months ago)
• Default Branch: master
• Last Pushed: 2024-09-24T08:13:26.000Z (about 2 months ago)
• Last Synced: 2024-10-07T16:56:40.467Z (about 1 month ago)
• Language: Svelte
• Homepage: https://libernotarum.vercel.app
• Size: 1 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


 







#  liber notarum

**Liber notarum** is a versatile note-taking app built with SvelteKit and Prisma that lets you manage and utilize your markdown content effectively.

**Key Benefits:**

- **Effortless Note Organization:** Structure your notes with ease using markdown syntax.

- **Seamless Data Storage:** Securely store and retrieve your notes with a user-friendly interface.

- **Powerful Database Integration:** Ensure efficient data management through Prisma.

**Getting Started**

- **Prerequisites:** Node.js and npm (or yarn) installed on your system (installation instructions: [https://nodejs.org/en](https://nodejs.org/en))

- **Clone the Repository:**

```bash

git clone https://github.com/Michael-Obele/libernotarum.git

```

- **Install Dependencies:**

```bash

cd liber-notarum

npm install  # or yarn install

```

- **Database Setup:**

  Configure your database connection details in `prisma/schema.prisma`.

  Run migrations to create or update your database schema:

  ```bash

  npx prisma migrate dev

  ```

  Replace `dev` with your desired environment (e.g., `production`) if applicable.

**Development**

1. **Start the Development Server:**

   ```bash

   npm run dev  # or yarn dev

   ```

   This opens the application in your default web browser, usually at `http://localhost:5173/`.

2. **Make Changes and See Results:**

   Edit files within the `src` directory using a code editor (e.g., Visual Studio Code, Sublime Text).

   The development server automatically refreshes the browser for a streamlined workflow.

**Deployment**

Refer to the SvelteKit documentation for detailed deployment instructions based on your preferred hosting platform: [https://kit.svelte.dev/docs/building-your-app](https://kit.svelte.dev/docs/building-your-app)

**Contributing**

We welcome contributions to liber notarum! If you have ideas for improvement or want to fix bugs, please create a pull request on GitHub. Refer to our contribution guidelines (if available) for a smooth review process.

[![Netlify Status](https://api.netlify.com/api/v1/badges/b7b3ab7a-cbdf-4c19-b71b-93b3c876b945/deploy-status)](https://app.netlify.com/sites/libernotarum/deploys)