Skip to content

Latest commit

 

History

History
59 lines (35 loc) · 1.35 KB

README.md

File metadata and controls

59 lines (35 loc) · 1.35 KB
Raw

Sphinx Logo

Sphinx API

REST API server for sphinx application to share secrets within organizations.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software

Installing

A step by step series of examples that tell you how to get a development env running

Install dependenccies

npm install

Set NODE environment

export NODE_ENV=<path_to_environemtns/development>

Configure the development.env file

Start the server

npm start

Deployment

Can be deployed using the docker container

Built With

  • NestJS - The web framework used
  • NPM - Dependency Management

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License - see the LICENSE.md file for details