Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fairnesscoop/permacoop
Open source and eco-designed ERP solution for worker-owned businesses.
https://github.com/fairnesscoop/permacoop
clean-code coop cqrs crm ddd ecodesign erp hexagonal-architecture nestjs nodejs open-source sapper sveltejs sveltekit typescript unit-testing
Last synced: 6 days ago
JSON representation
Open source and eco-designed ERP solution for worker-owned businesses.
- Host: GitHub
- URL: https://github.com/fairnesscoop/permacoop
- Owner: fairnesscoop
- License: mit
- Created: 2019-11-24T12:20:42.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-04T11:33:01.000Z (18 days ago)
- Last Synced: 2024-12-04T12:27:54.876Z (18 days ago)
- Topics: clean-code, coop, cqrs, crm, ddd, ecodesign, erp, hexagonal-architecture, nestjs, nodejs, open-source, sapper, sveltejs, sveltekit, typescript, unit-testing
- Language: TypeScript
- Homepage:
- Size: 5.92 MB
- Stars: 244
- Watchers: 11
- Forks: 34
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Permacoop is an open source and eco design ERP solution reserved for worker-owned business.
[](https://codecov.io/gh/fairnesscoop/permacoop)
[](https://scrutinizer-ci.com/g/fairnesscoop/permacoop/?branch=master)
[](https://www.codacy.com/gh/fairnesscoop/permacoop?utm_source=github.com&utm_medium=referral&utm_content=fairnesscoop/permacoop&utm_campaign=Badge_Grade)
[](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 default user "John Doe" :
```json
{
"email": "[email protected]",
"password": "john"
}
```
The server will be available at .
## 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