Skip to content

Commit

Permalink
packaging
Browse files Browse the repository at this point in the history
  • Loading branch information
remyla committed Nov 30, 2024
1 parent cb18654 commit 9e8d8a3
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 15 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/actions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ jobs:
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
- working-directory: ./server-nodejs
run: cp conf_template.json conf.json
- working-directory: ./server-nodejs
run: npm ci
- working-directory: ./server-nodejs
Expand Down
35 changes: 26 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,32 @@
# damas-core ![Licence](https://img.shields.io/github/license/remyla/damas-core) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/remyla/damas-core) ![Docker Pulls](https://img.shields.io/docker/pulls/primcode/damas-core) ![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/primcode/damas-core)


<img src="http://damas-software.org/bin/damas-core_logo.svg?t=2" alt="damas-core logo"/>

HTTP JSON storage using NodeJS focused on reliability, efficiency and extensibility.
```
_
__| | __ _ _ __ ___ __ _ ___ ___ ___ _ __ ___
/ _` |/ _` | '_ ` _ \ / _` / __|_____ / __/ _ \| '__/ _ \
| (_| | (_| | | | | | | (_| \__ \_____| (_| (_) | | | __/
\__,_|\__,_|_| |_| |_|\__,_|___/ \___\___/|_| \___|
```
JSON storage using NodeJS focused on reliability, efficiency and extensibility.

Its main features are:
* RESTful HTTP web service with CRUD functions based on [strict specifications](https://github.com/remyla/damas-core/wiki/4-Specifications)
* RESTful HTTP web service
* CRUD operations based on [strict specifications](https://github.com/remyla/damas-core/wiki/4-Specifications)
* [JSON web token authentication](https://github.com/remyla/damas-core/wiki/Authentication)
* [Server extensions](https://github.com/remyla/damas-core/wiki/Extensions)
* [Python and Javascript API](https://github.com/remyla/damas-core/wiki/3-API-reference)
* [Command line interface](https://github.com/remyla/damas-core/blob/master/cli/README.md)
* [Available extensions](https://github.com/remyla/damas-core/wiki/Extensions)
* [User authentication and permissions](https://github.com/remyla/damas-core/wiki/Authentication)

Directory structure:
```
├── cli/ client (Bash + curl)
├── docker/ package for deployment
├── js/ client (Javascript API)
├── py/ client (Python API)
├── server-nodejs/ server HTTP (NodeJS/Express)
├── server-tests/ server Jasmine unit tests
├── LICENSE GNU GPLv3 license
└── README.md this file
```

## Usage
Clone this repository and run:
Expand Down Expand Up @@ -46,6 +62,7 @@ http://primcode.com PRIMCODE is the company behind the development, the distribu
Remy Lalanne - Project lead
Thibault Allard
Julie Aresu
Aymeric Cadier
Sebastien Courtois
Ghislain Dugat
Joaquin Galvan Angeles
Expand All @@ -61,7 +78,7 @@ Quentin Villecroze
## License
GPL License(GPLV3)

Copyright(c) 2023 Remy Lalanne [email protected]
Copyright(c) 2024 Remy Lalanne [email protected]

damas-core is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Expand Down
File renamed without changes.
4 changes: 3 additions & 1 deletion docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,6 @@ To build a new damas-core image from sources:
docker compose build
```


## CONTRIBUTE
You can interact with the project raising issues and ideas here:
https://github.com/remyla/damas-core/issues
7 changes: 4 additions & 3 deletions docker/compose.yml → docker/compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,9 @@ services:
ports:
- 80:80
- 443:443
# networks:
# - damas_default
# # for reverse proxy (multiple domains, one damas each) add networks here
depends_on:
- damas
# # add reverse proxy networks
# # (multiple domains, one damas each)
# networks:
# - damas_default

0 comments on commit 9e8d8a3

Please sign in to comment.