msh2050/permacoop

Open source and eco design ERP solution reserved for worker-owned business.

Permacoop is an open source and eco design ERP solution reserved for worker-owned business.

Technical stack

• Node.js / Nestjs
• TypeORM
• Typescript
• Jest / Ts-mockito
• Svelte / Sapper
• Tailwind CSS
• PostgreSQL
• Redis
• Docker

Prerequisites

You must have Docker and Docker Compose.

Ensure you have Node.js v14.3 and node-gyp installed globally (npm install -g node-gyp). (Node version should match to avoid any build issues with binary dependencies such as argon2.)

Installation

At the first launch, just execute this command to install your application :

make install

For the next times you just need to execute this command to start your application :

make start

The server and client will be started:

• API documentation available on http://localhost/api
• Client avaible on http://localhost/

Security

The client must send the user apiToken in the Authorization header when making requests to protected resources : Authorization: Bearer <apiToken>

At the installation of the project a default user was created :

{
  "email": "john@doe.com",
  "password": "john"
}

To retrieve the apiToken, make a post request on /login with a user email and password.

Helpers

This following command will display all available helpers :

make help

Tests

Run the unit test suite with this following command:

make test

Features

• Tasks management
• Projects management
• Customers management
• Calendar (timesheets etc.)
• Human Resources
  • Meal tickets
  • Leaves
  • Cooperators / employee
  • Savings records
• Accounting
  • Quotations
  • Daily rates
  • Invoicing
• Contacts managment

Credits

Created by Fairness