Skip to content

Latest commit

 

History

History
179 lines (116 loc) · 6.98 KB

README.md

File metadata and controls

179 lines (116 loc) · 6.98 KB
Raw

QMailO

Install QMailO on your server (e. g. Uberspace) to organize your .qmail files. With it, you can view, add, edit and delete .qmail files. You can use the API to write your own scripts or frontend, or use the corresponding Angular frontend.

Setup

  • Clone the repository git clone https://github.com/kiwikern/qmailo.git
  • cd qmailo
  • Run npm install
  • Run npm run setup (Make sure you are in the root directory qmailo.)
  • Run npm start to start the server.
  • If you're using it on Ubserspace, you can also add it as an service.

Endpoints

/login

  • no authorization required
  • POST
    • request body (json):
      • password (required): The password you chose during the setup.
    • returns JWT token for authorized access of /files endpoint
    • example: curl -X POST -H "Content-Type: application/json" -d '{"password": "test"}' localhost:30000/login

/files

  • authorized with JWT token obtained with the login method
  • GET
    • query parameters:
      • search (optional): filter by file name.
    • returns a list of all .qmail files without the .qmail- prefix in the format {id: string, content: string}
  • PUT
    • request body (json):
      • id (required): file name without the .qmail- prefix
      • content (required): content of the .qmail file
    • creates a new .qmail file. Does not override existing ones.
  • POST
    • request body (json):
      • id (required): file name without the .qmail- prefix
      • content (required): content of the .qmail file
    • updates an existing .qmail file. Does not create new ones.

/files/:id

  • DELETE
    • url param :id: file name without the .qmail- prefix
    • deletes the given file if found

Qmailo

This project was generated using Nx.

🔎 Nx is a set of Extensible Dev Tools for Monorepos.

Quick Start & Documentation

Nx Documentation

10-minute video showing all Nx features

Interactive Tutorial

Adding capabilities to your workspace

Nx supports many plugins which add capabilities for developing different types of applications and different tools.

These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well.

Below are our core plugins:

  • Angular
    • ng add @nrwl/angular
  • React
    • ng add @nrwl/react
  • Web (no framework frontends)
    • ng add @nrwl/web
  • Nest
    • ng add @nrwl/nest
  • Express
    • ng add @nrwl/express
  • Node
    • ng add @nrwl/node

There are also many community plugins you could add.

Generate an application

Run ng g @nrwl/angular:app my-app to generate an application.

You can use any of the plugins above to generate applications as well.

When using Nx, you can create multiple applications and libraries in the same workspace.

Generate a library

Run ng g @nrwl/angular:lib my-lib to generate a library.

You can also use any of the plugins above to generate libraries as well.

Libraries are sharable across libraries and applications. They can be imported from @qmailo/mylib.

Development server

Run ng serve my-app for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run ng g component my-component --project=my-app to generate a new component.

Build

Run ng build my-app to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run ng test my-app to execute the unit tests via Jest.

Run nx affected:test to execute the unit tests affected by a change.

Running end-to-end tests

Run ng e2e my-app to execute the end-to-end tests via Cypress.

Run nx affected:e2e to execute the end-to-end tests affected by a change.

Understand your workspace

Run nx dep-graph to see a diagram of the dependencies of your projects.

Further help

Visit the Nx Documentation to learn more.

☁ Nx Cloud

Computation Memoization in the Cloud

Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times. Even teams that are new to Nx can connect to Nx Cloud and start saving time instantly.

Teams using Nx gain the advantage of building full-stack applications with their preferred framework alongside Nx’s advanced code generation and project dependency graph, plus a unified experience for both frontend and backend developers.

Visit Nx Cloud to learn more.

QmailoFrontend

QMailO helps you organize your .qmail files. For it to work, you need to set up the QMailO Server as well. This web app was designed with Uberspace in mind. The app is available in English and German.

Setup

  • Set up your QMailO Server.
  • Download the latest release and unzip the language version of your choice to the folder served by your web server.
  • Forward all requests to api/* to your QMailO server, e. g. localhost:30000, anything else to index.html.
    • There is a .htaccess included with a sample configuration. If you don't want to use it, you can just delete it.

Uberspace

  • If you're using Uberspace, you can easily create a subdomain for your QMailO Frontend.
  • Just create a folder with your subdomain name in /var/www/virtual/$USER/ and unzip the language version of your choice of the latest release into it.
    • Example: mkdir /var/www/virtual/$USER/qmailo.kimkern.de
  • Include your new subdomain in your LetsEncrypt certificate.
  • If your QMailO server is running under a different port than 30000, edit the included .htaccess file:
    • RewriteRule ^api/(.*) http://localhost:30000/$1 [P]

Development

  • Run npm start for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
  • Run npm run build to build the project. The build artifacts will be stored in the dist/ directory.
  • For further information about the Angular CLI, run npm run ng -- --help.