Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theanuragshukla/envoix-server
Server for theanuragshukla/envoix
https://github.com/theanuragshukla/envoix-server
environment environment-variables envoix npm-package sever
Last synced: 5 days ago
JSON representation
Server for theanuragshukla/envoix
- Host: GitHub
- URL: https://github.com/theanuragshukla/envoix-server
- Owner: theanuragshukla
- Created: 2024-04-10T12:21:50.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-05-07T12:14:37.000Z (6 months ago)
- Last Synced: 2024-05-07T13:29:57.166Z (6 months ago)
- Topics: environment, environment-variables, envoix, npm-package, sever
- Language: JavaScript
- Homepage:
- Size: 72.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Envoix-server
This repository contains server code for the npm package [envoix](https://github.com/theanuragshukla/envoix).
# Table of Contents
1. Introduction
2. Tech stack
3. Getting Started
1. Installation
2. Configuration
3. Running the Server
4. API Reference
1. Authentication Endpoints
2. Environment Variables Endpoints
3. Permission Management Endpoints
5. Security Considerations
6. Conclusion
# Tech Stack
- NodeJS (RTE)
- Postgres (Database)
- TypeORM (ORM)
- ExpressJS (web server)
- Bcrypt + crypto (security)
# Introduction
Envoix Server is built using Node.js and Express.js, providing a RESTful API for handling user authentication, environment variables management, and permission management. It leverages PostgreSQL as its database for storing user data, environment variables, and permissions.
# Getting Started
## Installation
To install Envoix Server, follow these steps:
1. Clone the Envoix Server repository:
```bash
git clone https://github.com/your_username/envoix-server.git
```
2. Navigate to the Envoix Server directory:
```bash
cd envoix-server
```
3. Install dependencies:
```bash
npm install
```
4. Configuration
Before running the server, configure the environment variables by copying the .env.example file to .env and providing appropriate values for your environment.
Running the Server
5. To start the Envoix Server, run the following command:
```bash
npm start
```
# API Reference
Envoix Server provides the following endpoints for managing authentication, environment variables, and permissions:
## Authentication Endpoints (/auth)
POST /auth/signup: Create a new user account.
POST /auth/login: Authenticate user credentials and generate an access token.
GET /auth/me: Retrieve user details (requires authentication).
Environment Variables Endpoints (/envs)
GET /envs: Retrieve all environment variables associated with the authenticated user.
POST /envs: Add a new environment variable.
GET /envs/:env_id: Retrieve an environment variable by ID.
PUT /envs/:env_id: Update an existing environment variable.
DELETE /envs/:env_id: Delete an environment variable.
Permission Management Endpoints (/permissions)
POST /permissions/:env_id: Add permissions for accessing an environment variable.
PUT /permissions/:env_id: Update existing permissions for accessing an environment variable.
DELETE /permissions/:env_id: Remove permissions for accessing an environment variable.
GET /permissions/:env_id: Retrieve permissions for an environment variable.
# Security Considerations
Envoix Server utilizes encryption techniques to ensure the security of sensitive data, such as user passwords and environment variable contents.
Access to sensitive endpoints and data is restricted based on user authentication and permissions.
Regularly review and update user permissions to maintain security.
Avoid sharing sensitive information in environment variables unless necessary.
# Conclusion
Envoix Server provides a robust backend solution for managing environment variables within development teams. By centralizing storage, enforcing encryption, and providing fine-grained access control, Envoix Server enhances collaboration while prioritizing security and simplicity.
# Author
developed by [Anurag Shukla](https://github.com/theanuragshukla)