permacoop

KO | EN

gitlite — search

#python #hacktoberfest #ruby #php #javascript #wordpress #dotfiles #shell #erlang #vim #library #latex

★ 265 Open GitHub ↗

Open source and eco-designed ERP solution for worker-owned businesses.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

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

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/fairnesscoop/permacoop/ci.yml?branch=master)
[![codecov](https://codecov.io/gh/fairnesscoop/permacoop/branch/master/graph/badge.svg)](https://codecov.io/gh/fairnesscoop/permacoop)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/fairnesscoop/permacoop/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/fairnesscoop/permacoop/?branch=master)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/3bf4f001d4904cdb89e71f2793d1c6b7)](https://www.codacy.com/gh/fairnesscoop/permacoop?utm_source=github.com&utm_medium=referral&utm_content=fairnesscoop/permacoop&utm_campaign=Badge_Grade)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/fairnesscoop/permacoop)
[![GitHub license](https://img.shields.io/github/license/fairnesscoop/permacoop.svg)](https://github.com/fairnesscoop/permacoop)

## Technical stack

- [Node.js](https://nodejs.org) / [Nestjs](https://nestjs.com/) / [Nunjucks](https://mozilla.github.io/nunjucks/templating.html)
- HTML, CSS, [WebComponents](https://developer.mozilla.org/en-US/docs/Web/API/Web_Components)
- [TypeORM](https://typeorm.io)
- [PostgreSQL](https://www.postgresql.org/)
- [Typescript](https://www.typescriptlang.org/)
- [Jest](https://jestjs.io/) / [ts-mockito](https://github.com/NagRock/ts-mockito)
- [Docker](https://www.docker.com/)

## Prerequisites

You must have **[PostgreSQL](https://www.postgresql.org/)** installed, or **[Docker](https://www.docker.com/)** and **[Docker Compose](https://docs.docker.com/compose/)** to run PostgreSQL using the provided `docker-compose.yml`.

Ensure you have [Node.js](https://nodejs.org) **16.x** and `node-gyp` installed globally (`npm install -g node-gyp`).

## Quickstart

First, install dependencies:

```bash
make install
```

Then start the servers, database and other services:

```
make start
```

In a separate terminal, run database migrations:

```
make database-migrate
```

Then, you can seed the database with fake data

```
make database-seed
```

This command will create the following seed accounts:

| Name | Email | Password | Role |
|------|-------|----------|------|
| John Doe | john@doe.com | john | COOPERATOR |
| Jane Smith | jane@smith.com | john | COOPERATOR |

4 additional users are also created with random emails (generated by faker) — they all share the same password: `john`.

The server will be available at <http://localhost:3000>.

## Helpers

To view all available commands, run:

```bash
make help
```

### Building and serving

To serve the built server and client locally, run:

```bash
make build
make start-dist
```

### Tests

To run tests, use:

```bash
make test
```

Run E2E tests using:

```bash
make test-e2e
```

### Code quality

To run automatic code formatting, run:

```bash
make format
```

To run linters and code checks, use:

```bash
make linter
```

### Database migrations

To generate a migration from the current state of the code, run:

```bash
make database-migration NAME=add_some_column
```

## Features

- Tasks management
- Projects management
- Customers management
- Calendar (timesheets etc.)
- Human Resources
  - Meal tickets
  - Leaves
  - Cooperators / employee

## Credits

Created by [Fairness](https://fairness.coop)

## License

MIT

permacoop

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README