Skip to content

A secret server that can be used to store and share secrets using a randomly generated URL. The secret can be read only a limited number of times after that it will expire and won’t be available. The secret has a TTL (Time to live). After the expiration time the secret won’t be available anymore.

Notifications You must be signed in to change notification settings

lil-armstrong/secretServer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 

Repository files navigation

SecretServer

A secret server that can be used to store and share secrets using a randomly generated URL. The secret can be read only a limited number of times after that it will expire and won’t be available. The secret has a TTL (Time to live). After the expiration time the secret won’t be available anymore.

This app consists of both the client-side and server-side code implementation. All server-side code is in the server folder, while the client-side code is in the folder named client

How to run server-side code

To connect to the correct mongoose database, create a .env file in the server folder and put the following

DB_USER=admin
DB_PASSWORD=secretServer
DB_NAME=secrets
  • Change to the server folder
  • On your terminal, type the following commands in order

For yarn users

# For yarn
# Install all dependencies
  yarn
# Start server
  yarn serve

For npm users

# For npm
# Install all dependencies
  npm install
# Start server
  npm run serve

How to run client-side code

The client-side code uses a minimalistic Vuejs single page component setup generated using the Vue cli tool.

The client-side also depends on environment variables. I decided not to use a fallback, since this is a demo app. Please create a .env file in the client folder and put the following

BASE_URL=/
VUE_APP_SERVER_HOST=localhost
VUE_APP_SERVER_PORT=8000
  • Change to the client folder
  • On your terminal, type the following commands in order

For yarn users

# For yarn
# Install all dependencies
  yarn
# Start server
  yarn serve

For npm users

# For npm
# Install all dependencies
  npm install
# Start server
  npm run serve

Server-side Test

In this project, I used jest as a unit testing framework for the server side. To run all test, change to the server folder and run the following commands

# Run all test
yarn test
# or
npm run test

About

A secret server that can be used to store and share secrets using a randomly generated URL. The secret can be read only a limited number of times after that it will expire and won’t be available. The secret has a TTL (Time to live). After the expiration time the secret won’t be available anymore.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published