Mnemosine Wiki - Deploy your wiki with markdowns without servers !

The Most Powerful JMstack WIKI Made with Angular is Serverless and API-less! πŸ’ͺ

πŸ”₯ What is Serverless? πŸš€

Serverless is a cloud computing model where you don't manage servers. Instead, you pay only for specific functions that execute in response to events.

Advantages of Serverless:

  • Automatic Scalability: Functions scale automatically based on demand.
  • Cost Efficiency: You pay only for the execution time of your functions, not for idle servers.
  • Less Maintenance: No need to worry about server infrastructure maintenance.

🌐 What is API-less Architecture? πŸ€”

API-less architecture focuses on building applications without directly interacting with APIs for every piece of functionality. Instead, it may rely on static data or built-in functions and services. This can simplify development and reduce dependencies on external systems.

Benefits of API-less Architecture:

  • Simpler Development: Fewer dependencies and reduced complexity.
  • Faster Execution: Eliminates the need for API calls, which can speed up performance.
  • Reduced Costs: Fewer external services may mean lower operational costs.

πŸŽ‰ How Do JAMstack and Serverless Relate?

JAMstack and Serverless complement each other perfectly. While JAMstack focuses on a modern, fast frontend architecture, Serverless handles backend logic seamlessly without the need for server management. Together, they provide a robust and efficient solution for building web applications and sites.

πŸ› οΈ How to Use Mnemosine Wiki

1. Setting Up Your Environment

Before you start, ensure you have Node.js and npm installed.

 git clone [email protected]:bylidev/mnemosine-wiki.git

Now you will see the following directory structure:

-- 
    |-- app
    |-- 
    |---- images
    |---- *.md
-- app
    |-- src
    |-- package.json
    |-- angular.json
    |-- ...

To this point, you have created a new Mnemosine Wiki project with the default structure.

3. Running Your Mnemosine Wiki Project πŸš€

cd ./app
npm install
ng serve

4. Markdown needed metadata πŸ“

When creating a new markdown file, you need to add the following metadata at the beginning of the file:

---
title: "Mnemosine Wiki - The Most Powerful JAMstack  Made with Angular is Serverless and API-less!"
author: "Ignacio Lopez"
route: "abstract-factory"
thumb: "caffee.gif"
date: "2024-07-20"
tags:
  - markdown
---
  • title: The title of the article. πŸ“š
  • author: The author of the article. ✍️
  • route: The Angular route of the article. 🌐
  • thumb: The thumbnail of the article (this image will be resized). πŸ–ΌοΈ
  • date: The date of the article (important for sorting). πŸ“…
  • tags: Tags of the article (important for generating tags and SEO metadata). 🏷️

5. backups πŸ’Ύ

You only need to backup the ` directory, as it contains all your content. The app` directory is your Angular project, and you can always recreate it.

6. Deploying your Mnemosine Wiki πŸš€

You can deploy your Mnemosine Wiki to any static hosting provider, like gitlab pages, github pages, cloudflare pages. Just build your Angular app and deploy the dist directory. Mnemosine Wiki , provides you a configured workflow for github pages.

;