Giter Club home page Giter Club logo

arte-server's Introduction

logo Arte-server

A simple artifact server with front-end, CLI, webhook and in the future authentication/authorization and retention policy

Node.js version support Build Coverage MIT licensed

Summary

  1. Description
  2. Technology and Requirements
  3. Getting Started
  4. Contributing
  5. Support and Migration
  6. Code of Conduct
  7. License

Description

The Arte server is a simple and straightforward artifact storage server. It has a UI to help the user find the artifact a CLI to help developers to upload and download their binaries and a webhook to help with the flow of a CI system.

Below a list of planned features:

  • Authentication/authorization (using tokens);
  • Retention policy;
  • Swagger API documentation;

UI:

UI

Technology and Requirements

This project uses the following stack:

  • Node.js for the back-end and CLI;
  • Pug.js for the front-end (server-side rendering);
  • MongoDB to store the artifact metadata;
  • Filesystem to store the binary of the artifact;

Getting Started

Local:

# Clone the repository
$ git clone https://github.com/conradoqg/arte-server.git

# Install the dependencies
$ npm install

# Install MongoDB

# Run the arte-server
$ cd arte-server
$ node ./bin/arte-server.js

Using Docker (you must install docker beforehand):

# Clone the repository
$ git clone https://github.com/conradoqg/arte-server.git

# Install the dependencies
$ npm install

# Install MongoDB

# Build docker image
$ docker build . -t arte-server:latest

# Run a docker container using the previous image
$ docker run -it --rm -p 80:80 arte-server:latest

Usind Docker Compose (you must install docker beforehand):

# Clone the repository
$ git clone https://github.com/conradoqg/arte-server.git

# Install the dependencies
$ npm install

# Docker compose up
$ docker-compose up

Contributing

Check the contributing guide to see more information.

Before submitting a pull request make sure that your code is passing the tests and has a good coverage

# Run only the tests
$ npm test

# Run tests and coverage
$ npm run coverage

Support and Migration

This is a beta server, there is no support right now until it becomes stable. Expect breaking changes on every commit.

Code of Conduct

Check the code of conduct to see more information.

License

This project is licensed under the MIT License.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.